Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
The commands below are presumed to be run relative to the project root
unless explicitly stated otherwise.
./ also refers to the project root.
Ways You Can Help Us¶
Create an issue corresponding to the bug you have found complying with the project’s issue template.
Look through the GitHub issues: Anything tagged with
bug and without an
is open to whoever wants to implement it.
Make sure to submit clean, concise, well-tested pull requests only, so it is easier for contributors to review it; strive to deliver as short and atomic pull requests as possible as this will dramatically increase the likelihood of those being merged.
Look through the GitHub issues for features. Anything tagged with
help wanted and/or without an
Assignee is open to whoever
wants to implement it.
We could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
See Developing Locally for detailed instructions on setting up local environment.
Oncer you are all set up,
create a branch:
$ git checkout -b <issue id>-<issue title>
make the contribution;
follow Running tox with Multiple Python Distributions to run tests comprehensively;
commit changes to the branch:
$ git add . $ git commit -m "<detailed description of your changes>"
push the branch to GitHub:
$ git push origin <issue id>-<issue title>
submit a pull request via GitHub or any other git GUI tool you prefer.
Upon submission, make sure the PR meets these guidelines:
- the PR does not decrease code coverage (unless there is a very specific reason to);
- the docs (both programmatic and manual) are updated, if needed.