pre-commit install instructions are incomplete #1360

Activity

1. hugovk commented on Aug 15, 2024

   

   hugovk

   on Aug 15, 2024

   Member

   More actions

   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.

   👍React with 👍2Reacted by Zion Amsalem and Stan Ulbrych
2. encukou

   closed this as completedon Jan 22, 2025