IMPORTANT: Please take note of the below checklist, especially the first two items.
- All pull requests must include the Contributor License Agreement (see below).
- Code should conform to the following:
- pep8 compliant with some exceptions (see pytest.ini)
- 100% test coverage with pytest (with valid tests). If you have difficulty writing tests for the code, feel free to ask for help or submit the PR without tests.
- Complete, correctly-formatted documentation for all classes, functions and methods.
- documentation has been rebuilt with
tox -e docs - All modules should have (and use) module-level loggers.
- Commit messages should be meaningful, and reference the Issue number if you're working on a GitHub issue (i.e. "issue #x - "). Please refrain from using the "fixes #x" notation unless you are sure that the the issue is fixed in that commit.
- Git history is fully intact; please do not squash or rewrite history.
By submitting this work for inclusion in python-package-skeleton, I agree to the following terms:
- The contribution included in this request (and any subsequent revisions or versions of it) is being made under the same license as the python-package-skeleton project (the Affero GPL v3, or any subsequent version of that license if adopted by python-package-skeleton).
- My contribution may perpetually be included in and distributed with python-package-skeleton; submitting this pull request grants a perpetual, global, unlimited license for it to be used and distributed under the terms of python-package-skeleton's license.
- I have the legal power and rights to agree to these terms.