- All potential contributors must read the
code-of-conduct
and follow it - Fork the repository on GitHub or GitLab
- Create a new branch, e.g.,
git checkout -b bug/12345
- Fix the bug and add tests (if applicable1, see
how-to-add-tests
) - Run the tests (see
how-to-run-tests
below) - Add documentation (as necessary) for your change
- Build the documentation to check for errors and formatting (see
how-to-build-the-docs
below) - Add yourself to the
AUTHORS.rst
(unless you're already there) - Commit it. Follow these rules in your commit message:
- Keep the subject line under 50 characters
- Use an imperative verb to start the commit
- Use an empty line between the subject and the message
- Describe the why in detail in the message portion of the commit
- Wrap the lines of the message at 72 characters
- Add the appropriate "Closes #12345" syntax to autoclose the issue it fixed (if it closes an issue)
- See
example-commit-message
below
- Push it to your fork
- Create a request for us to merge your contribution
After this last step, it is possible that we may leave feedback in the form of review comments. When addressing these comments, you can follow two strategies:
- Amend/rebase your changes into an existing commit
- Create a new commit with a different message2 describing the changes in that commit and push it to your branch
This project is not opinionated about which approach you should prefer. We only ask that you are aware of the following:
- Neither GitHub nor GitLab notifies us that you have pushed new changes. A friendly ping is encouraged
- If you continue to use the same branch that you created the request from, both GitHub and GitLab will update the request on the website. You do not need to create a new request for the new changes.
We use pytest to run tests and to simplify how we write tests. If you're fixing a bug in an existing please find tests for that module or feature and add to them. Most tests live in the tests
directory. If you're adding a new feature in a new submodule, please create a new module of test code. For example, if you're adding a submodule named foo
then you would create tests/test_foo.py
which will contain the tests for the foo
submodule.
Run the tests in this project using tox. Before you run the tests, ensure you have installed tox either using your system package manager (e.g., apt, yum, etc.), or your prefered python installer (e.g., pip).
Then run the tests on at least Python 2.7 and Python 3.x, e.g.,
$ tox -e py27,py34
Finally run one, or both, of the flake8 style enforcers, e.g.,
$ tox -e py27-flake8
# or
$ tox -e py34-flake8
It is preferable if you run both to catch syntax errors that might occur in Python 2 or Python 3 (based on how familiar you are with the common subset of language from both).
Tox will manage virtual environments and dependencies for you so it will be the only dependency you need to install to contribute to this project.
To build the docs, you need to ensure tox is installed and then you may run
$ tox -e docs
This will build the documentation into docs/_build/html
. If you then run
$ python2.7 -m SimpleHTTPServer
# or
$ python3.4 -m http.server
from that directory, you can view the docs locally at http://localhost:8000/.
Allow users to use the frob when uploading data
When uploading data with FooBar, users may need to use the frob method
to ensure that pieces of data are not munged.
Closes #1234567