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.

Sign up for GitHub

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

Jump to bottom

Include contributor docs for how to use pre-commit #29

Open
MichaelClifford opened this issue Jan 26, 2021 · 0 comments
Open

Include contributor docs for how to use pre-commit #29

MichaelClifford opened this issue Jan 26, 2021 · 0 comments
Assignees
@tumido
Labels
documentation Improvements or additions to documentation kind/feature Categorizes issue or PR as related to a new feature.

Comments

@MichaelClifford
Copy link
Member

Is your feature request related to a problem? Please describe.
I have experienced that many people using this template making their first PR fail the pre-commit check since they are unfamiliar with using this tool.

Describe the solution you'd like
Include a doc into the template, or possibly update the readme, to include a section on how to install and use "pre-commit" before pushing code for a new PR.

Describe alternatives you've considered
No other alternatives have been considered, but would be open to one : )
@MichaelClifford MichaelClifford added documentation Improvements or additions to documentation enhancement labels Jan 26, 2021
@tumido tumido self-assigned this Jan 27, 2021
@sesheta sesheta added kind/feature Categorizes issue or PR as related to a new feature. and removed enhancement labels Feb 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tumido tumido

Labels
documentation Improvements or additions to documentation kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@MichaelClifford @tumido @sesheta