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

pre-commit install instructions are incomplete #1360

Open
encukou opened this issue Jul 23, 2024 · 1 comment
Open

pre-commit install instructions are incomplete #1360

encukou opened this issue Jul 23, 2024 · 1 comment

Comments

@encukou
Copy link
Member

encukou commented Jul 23, 2024

The current pre-commit install instructions are listed before the “Compile and build” section:

$ pre-commit install --allow-missing-config
pre-commit installed at .git/hooks/pre-commit

This doesn't work before pre-commit itself is installed, and it can't be installed if one doesn't have Python yet.

@hugovk
Copy link
Member

hugovk commented Aug 15, 2024

The instructions in full are:


Install pre-commit as a Git hook

To make sure your code is linted correctly, we recommend setting up pre-commit as a Git hook:

$ pre-commit install --allow-missing-config
pre-commit installed at .git/hooks/pre-commit

Now pre-commit will run automatically on git commit.


That pre-commit link is to https://pre-commit.com/#installation which shows a couple of ways to install pre-commit.

I don't think we need to instruct people how to install Python itself: I think if someone wants to contribute to Python development, they will already have a Python installation, or know how to do so. And if nothing else, the front page of the devguide begins with instructions on how to build Python.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants