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.
It all sounds reasonable and you should go for it. I think that contributing guide was written before we added hooks etc, so we just forgot to update it.
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:
pre-commit
to thedocs/requirements.txt
, andpre-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 \