- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)
- Documentation change (documentation changes only)
- Version change
- Build or continuous integration change
- I have read the contribution guide.
- My code follows the code style of this project.
Bug fix checklist:
- My fix includes a new test that breaks as a result of the bug (if possible).
- All new and existing tests pass.
- I have updated the CHANGELOG.
New feature checklist:
- I have added or updated the docstrings associated with my feature using the numpy docstring format.
- I have updated the tutorial to highlight my new feature (if appropriate).
- I have added tests to cover my new feature.
- All new and existing tests pass.
- I have updated the CHANGELOG.
Breaking change checklist:
- I have updated the docstrings associated with my change using the numpy docstring format.
- I have updated the tutorial to reflect my changes (if appropriate).
- My change includes backwards compatibility and deprecation warnings (if possible).
- I have added tests to cover my changes.
- All new and existing tests pass.
- I have updated the CHANGELOG.
Documentation change checklist:
- Any updated docstrings use the numpy docstring format.
- If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)
Version change checklist:
- I have updated the CHANGELOG to put all the unreleased changes under the new version (leaving the unreleased section empty).
- I have noted any dependency changes since the last version and will update the conda package build accordingly.
Build or continuous integration change checklist:
- If required or optional dependencies have changed (including version numbers), I have updated the readme to reflect this.
- If this is a new CI setup, I have added the associated badge to the readme and to references/make_index.py (if appropriate).