CONTRIBUTING.rst

Contributing

Pull requests are the best way to propose changes to the codebase. Contributions are welcome, but they have to meet some criteria.

Pull Request Process

1. Fork this Git repository and create your branch from master.

2. 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)

3. If you add code that should be tested, add tests.

4. 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')

5. If relevant, update documentation (either in docs directly or in rules files themselves).
6. 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).
7. Then, open a pull request.