Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
sfmig opened this issue Jun 13, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@sfmig
Copy link
Collaborator

sfmig commented Jun 13, 2024

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
\

@sfmig sfmig added the enhancement New feature or request label Jun 13, 2024
@niksirbi
Copy link
Member

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.

@sfmig sfmig self-assigned this Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants