Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to example .pre-commit-config.yamls #29

Open
asottile opened this issue Dec 1, 2014 · 2 comments
Open

Add links to example .pre-commit-config.yamls #29

asottile opened this issue Dec 1, 2014 · 2 comments

Comments

@asottile
Copy link
Member

asottile commented Dec 1, 2014

The documentation could use with more links to some examples. (Adding issue on behalf of @ivanlei)

@philipmulcahy
Copy link

The section starting with "Adding pre-commit plugins to your project" is pretty unclear.
Maybe it could be worded differently and show usage of more/most of the "keywords"?

s/The pre-commit config file describes:/The following directives/options control which hooks are applied to your project and how they behave:/

Also, the table should clarify at what level in the file the different words are relevant - for example "sha" applies one level higher than "id" - you could either split the table into two groups, one for the top level (per repo) and one for the lower level (per hook). I reckon a BNF for the config file format is overkill, but the current setup is not clear enough.

@asottile
Copy link
Member Author

asottile commented Oct 4, 2017

@philipmulcahy (yes, I'm very late to the party) separating out repo / sha just happened in #138 so now it's a little more obvious (I hope!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants