Skip to content

Should we add pre-commit to the docs/requirements.txt and to CONTRIBUTING.md? #60

@sfmig

Description

@sfmig

Is your feature request related to a problem? Please describe.
We are asking contributors to check they run the required pre-commits which is great, but the contribution guidelines do not mention the pre-commit installation.

Describe the solution you'd like
I think the easiest way would be:

  • to add pre-commit to the docs/requirements.txt, and
  • add a pre-commit install command in the CONTRIBUTING.md to install the provided hooks.

Maybe the Github workflow section could also be reorganised. I think I would have first the dependencies installation, next the "github workflow", and last the local build commands.

Describe alternatives you've considered
\

Additional context
\

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions