We love pull requests. Here's a quick guide:
- Make sure you have a GitHub account
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub
Create a topic branch from where you want to base your work.
This is usually the master branch.
Only target release branches if you are certain your fix must be on that branch.
To quickly create a topic branch based on master;
git branch fix/master/my_contribution masterthen checkout the new branch withgit checkout fix/master/my_contribution. Please avoid working directly on themasterbranch.Make commits of logical units.
Follow our coding style. You can run
make lintto format your code.Check for unnecessary whitespace with
git diff --checkbefore committing.Make sure you have added the necessary tests for your changes.
Run
make lintin the repository directory and commit any changes it makes.Run all the tests to assure nothing else was accidentally broken:
$ python -m pip install tox $ tox
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository.