neuroinformatics-unit / HowTo

NIU website on common software problems and their troubleshooting
http://howto.neuroinformatics.dev/
Creative Commons Attribution 4.0 International
9 stars 1 forks source link

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

Open sfmig opened 1 month ago

sfmig commented 1 month ago

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:

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 \

niksirbi commented 1 month ago

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.