diff options
| author | Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> | 2018-04-19 11:36:29 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-19 11:36:29 +0200 |
| commit | 72d8f1e9e64f63d686f091c6e02eb29ac8c5b769 (patch) | |
| tree | 177a5af8ae46e4f99035ae6d8626446d244f33c9 /.github | |
| parent | 3268424dd124f180a8cf254ca3c489b459f8d928 (diff) | |
| download | cherrypy-git-72d8f1e9e64f63d686f091c6e02eb29ac8c5b769.tar.gz | |
Clarify pre-commit note in CONTRIBUTING doc
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 427ee4c9..b26c72ed 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -3,7 +3,11 @@ Read and contribute to CherryPy Make sure you read the `README <https://github.com/cherrypy/cherrypy/blob/master/README.rst>`_. Also **ensure -you set up pre-commit utility correctly** and TravisCI tests pass. +you set up `pre-commit utility <https://pre-commit.com/#install>`_ correctly** +and TravisCI tests pass:: + + pre-commit run --all-files # runs the same checks as in CI locally + pre-commit install # sets up itself as a pre-commit hook of your local repo Submitting Pull Requests ------------------------ |