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

Make it clear where config file should go #403

Closed
wants to merge 1 commit into from

Conversation

@lfdebrux
Copy link

@lfdebrux lfdebrux commented Oct 9, 2020

It took me a while to work out where the file .pre-commit-config.yaml in step 2 should go. I think this small change will make it clearer for others.

It took me a while to work out where the file `.pre-commit-config.yaml` in step 2 should go. I think this small change will make it clearer for others.
Copy link
Member

@asottile asottile left a comment

the word "project" is ambiguous, I'd rather rely on the existing documentation

thanks for the patch but I'm going to decline this

@@ -100,9 +100,9 @@ conda install -c conda-forge pre-commit
pre-commit --version
```
### 2. Add a pre-commit configuration
### 2. Add a pre-commit configuration to your project

This comment has been minimized.

@asottile

asottile Oct 9, 2020
Member

I don't think this adds anything

- create a file named `.pre-commit-config.yaml`
- create a file named `.pre-commit-config.yaml` in the root level of your project

This comment has been minimized.

@asottile

asottile Oct 9, 2020
Member

this is already mentioned here

@asottile asottile closed this Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.