aicoe-aiops / project-template

this is a template to use for new data science projects in the aiops group
Other
8 stars 21 forks source link

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

Open MichaelClifford opened 3 years ago

MichaelClifford commented 3 years ago

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 : )