pytest and flake8 are used for quality control.
To run all tests:
pytestTo run linting:
flake8 .These steps are mandatory during the CI.
Please send a GitHub Pull Request with a clear list of what has been done (read more about pull requests). Please follow coding conventions (below) and make sure all of the commits are atomic (one feature per commit).
Always write a clear log message for the commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
- Click 'Fork' on Github, creating e.g.
username/theproject. - Clone the project:
git clone git@github.com:username/theproject. Create and activate a virtual environment <https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments>_.- Install the development requirements:
pip install -r requirements.txt. - Create a branch:
git checkout -b foo-the-bars 1.3.
- Add changelog entry.
- Write tests expecting the correct/fixed functionality; make sure they fail.
- Hack, hack, hack.
- Run tests again, making sure they pass.
- Commit your changes:
git commit -m "Foo the bars"
- Push the commit to get it back up to your fork:
git push origin HEAD - Visit Github, click "Pull request" button that it will make upon noticing your new branch.
- In the description field, write down issue number (if submitting code fixing an existing issue) or describe the issue + your fix (if submitting a wholly new bugfix).
- Hit 'submit'.
- Follow the style you see used in the primary repository. Consistency with the rest of the project always trumps other considerations.
- Python projects usually follow the PEP-8 guidelines.
- The code is indented using four spaces (soft tabs).
- This is open source software. Consider the people who will read the code.