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

Dev docs: Document that we use pre-commit hooks #9503

Open
benjaoming opened this issue Aug 16, 2022 · 2 comments
Open

Dev docs: Document that we use pre-commit hooks #9503

benjaoming opened this issue Aug 16, 2022 · 2 comments
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@benjaoming
Copy link
Contributor

While going over our Docs for Development Installation, I didn't find any mention of pre-commit hooks.

They are to be considered a mandatory part of development (as they are enforced in CI builds) and it's a big disadvantage to miss them in a local setup.

@benjaoming benjaoming added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels Aug 16, 2022
@humitos
Copy link
Member

humitos commented Aug 16, 2022

I think it's important to mention this in the contributing guide, for sure. IIRC, we didn't mention this when we started using pre-commit because we weren't 100% sure we will be adopting this pattern. However, I think we are already all on board with the current pattern and we are ready to document it so contributors also run pre-commit on their own PRs.

@htech9
Copy link

htech9 commented Sep 26, 2024

@humitos
Would you have any recommandation on where is a good location to place this documentation about pre-commit among current menus ?
So that opening a PR would be easier for this current issue.

rtd_dev_installation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants