Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 927 Bytes

PULL_REQUEST_TEMPLATE.md

File metadata and controls

30 lines (24 loc) · 927 Bytes

This PR has the objective of...

Changes

  1. Added new xyz to...
  2. Fixed a bug in...
  3. Changed the behaviour of...
  4. Improved the docs about...

Checklist

Checklist for for pull requests including new code and/or changes to existing code...

  • Code
    • Includes unit tests
    • New functions have docstrings with examples that can be run with doctest
    • New functions are included in API docs
    • Docstrings include notes for any changes to API or behaviour
    • All changes documented in docs/changes.rst
  • Testing
    • (Optional) Tested local against remote servers
    • Travis CI passes (unit tests run under Linux)
    • AppVeyor CI passes (unit tests run under Windows)
    • Unit test coverage has not decreased (see Coveralls)
  • Changes
    • (Optional) Just a proof of concept
    • (Optional) Work in progress
    • Ready to review
    • Ready to merge