Pull requests are the best way to propose changes to the codebase. Contributions are welcome, but they have to meet some criteria.
- Fork this Git repository and create your branch from
master
. Make sure the tests pass:
pip install --user . python -m unittest discover # all tests... python -m unittest tests/rules/test_commas.py # or just some tests (faster)
- If you add code that should be tested, add tests.
Make sure the linters pass:
flake8 .
If you added/modified documentation:
doc8 $(git ls-files '*.rst')
If you touched YAML files:
yamllint --strict $(git ls-files '*.yaml' '*.yml')
- If relevant, update documentation (either in
docs
directly or in rules files themselves). - Write a good commit message. If the pull request has multiple commits, each must be atomic (single irreducible change that makes sense on its own).
- Then, open a pull request.