Update docs for pre-commit (auto linting) #3332
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericholscher
approved these changes
Nov 29, 2017
agjohnson
requested changes
Nov 29, 2017
docs/contribute.rst
Outdated
| $ unify --quote="'" | ||
| $ yapf --exclude=*migrations* --exclude=*settings* --exclude=*scripts* --parallel | ||
| We have a strict code style that it's easy to follow since you just have to | ||
| install `pre-commit`_ and it will be ran automatically as a pre-commit hook for |
There was a problem hiding this comment.
ran -> run
Also, can drop the pre-commit hook for git, as we aren't actually prescribing that use yet.
docs/contribute.rst
Outdated
| $ yapf --exclude=*migrations* --exclude=*settings* --exclude=*scripts* --parallel | ||
| We have a strict code style that it's easy to follow since you just have to | ||
| install `pre-commit`_ and it will be ran automatically as a pre-commit hook for | ||
| git. This hook will run a different linting tools (`autoflake`_, `autopep8`_, |
There was a problem hiding this comment.
Also hook here -- we should prescribe running this as a standalone command for now.
docs/contribute.rst
Outdated
| git. This hook will run a different linting tools (`autoflake`_, `autopep8`_, | ||
| `docformatter`_, `isort`_, `prospector`_, `unify`_ and `yapf`_) to check your | ||
| changes before you commit them and let you know if there are some problems that | ||
| weren't able to fix automatically. |
There was a problem hiding this comment.
weren't able to fix -> weren't fixed
docs/contribute.rst
Outdated
| commands:: | ||
|
|
||
| $ pip install -U pre-commit | ||
| $ pre-commit install |
There was a problem hiding this comment.
Perhaps note the pre-commit install step as a separate "beta" usage of precommit hooks
agjohnson
approved these changes
Dec 1, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.