This checklist serves as a guide for contributors and maintainers to assess
whether a contribution can be merged into the main branch and thus serves
to guarantee the quality of the package. Please also read the
contribution guideline.
Before you submit a pull request, please go through this checklist once
more, as it will decrease the number of unnecessary review cycles.
However, this list is there to help all contributors to produce high
quality code, not to deter you from contributing. If you can't tick some of the
boxes, feel free to submit the pull request anyway and report about it in the
pull request message. Also, some of the boxes might not apply to the specific
type of your contribution.
[x] The contribution has been discussed and agreed on in the Issue section.
Pull Request Check List
This checklist serves as a guide for contributors and maintainers to assess whether a contribution can be merged into the main branch and thus serves to guarantee the quality of the package. Please also read the contribution guideline.
Before you submit a pull request, please go through this checklist once more, as it will decrease the number of unnecessary review cycles. However, this list is there to help all contributors to produce high quality code, not to deter you from contributing. If you can't tick some of the boxes, feel free to submit the pull request anyway and report about it in the pull request message. Also, some of the boxes might not apply to the specific type of your contribution.
tox -e py36
(to runpytest
) the code tests.tox -e style
(to runpylint
) the code style tests.tox -e docs
(to runsphinx
) generate the documentation./docs/pages/modules.rst
has been updated./docs/pages/api.rst
has been updated.