Skip to content
This repository was archived by the owner on Apr 10, 2025. It is now read-only.
This repository was archived by the owner on Apr 10, 2025. It is now read-only.

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

Open
@MichaelClifford

Description

@MichaelClifford

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationkind/featureCategorizes issue or PR as related to a new feature.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions