diff options
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 30024e29..d6acb2b7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -108,6 +108,20 @@ Development Workflow problems early and reduces the load on the continuous integration system. +4. Ensure your contribution is properly formatted. + + * If you installed ``pre-commit`` as recommended in step 1, all necessary + linting should run automatically at commit time. If there are any + formatting issues, the commit will not be successful and linting + suggestions will be applied to the patch automatically. + Simply ``git add`` and ``git commit`` a second time to accept the proposed + formatting changes. + + * If the above fails for whatever reason, you can also run the linter over + the entire codebase with:: + + pre-commit run --all-files + 4. Submit your contribution: * Push your changes back to your fork on GitHub:: |