Fix readme to correctly reflect no-commit-to-branch args #318
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
asottile
reviewed
Oct 4, 2018
README.md
Outdated
| @@ -82,7 +82,7 @@ Add this to your `.pre-commit-config.yaml` | |||
| - `name-tests-test` - Assert that files in tests/ end in `_test.py`. | |||
| - Use `args: ['--django']` to match `test*.py` instead. | |||
| - `no-commit-to-branch` - Protect specific branches from direct checkins. | |||
| - Use `args: [--branch <branch>]` to set the branch. `master` is the | |||
| - Use `args: ['staging', 'master']` to set the branch. `master` is the | |||
There was a problem hiding this comment.
ah yeah this would be args: [--branch, staging, --branch, master] -- good catch!
asottile
approved these changes
Oct 10, 2018
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.
Current documentation to use the
no-commit-to-branchis kinda confusing. So updated it to reflect how it correctly works.