Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
[ ] New feature (non-breaking change which adds functionality)
[x] Optimization (back-end change that improves speed/readability/etc.)
[ ] Bug fix (non-breaking change which fixes an issue)
Key checklist:
[x] No style issues: $ nox -s linter [-- format] (the format option will try to fix errors)
[x] Docstrings/comments are free of misspellings: $ nox -s codespell [-- write] (the write option will try to fix errors)
[x] All tests pass: $ nox -s tests
[x] New badges have been generated: $ nox -s badges
You can also run all of the above checks using $ nox -s pre-commit instead of running them individually.
Further checks:
[x] Code is commented, particularly in hard-to-understand areas
[x] Tests are added that prove fix is effective or that feature works
Description
Simple cleanup of files, images, etc.
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Key checklist:
$ nox -s linter [-- format]
(theformat
option will try to fix errors)$ nox -s codespell [-- write]
(thewrite
option will try to fix errors)$ nox -s tests
$ nox -s badges
You can also run all of the above checks using
$ nox -s pre-commit
instead of running them individually.Further checks: