🟣 Git Hooks

Install the project's Git hooks and run the checks.

WHY?

Git hooks catch common issues before code is committed and pushed to GitHub. Once installed, they run the project's automated checks every time git commit is used.

A newly-cloned repository does not include installed hooks, so install them for each local copy.

Step 1. Install the Hooks and Run the Checks

Open a VS Code terminal in the project root folder. Copy and paste one command at a time, and press Enter or Return after each:

uvx prek install --force
uvx prek update

git add -A
uvx prek run --all-files

If checks automatically modify files, review the changes and re-run (UP ARROW):

uvx prek run --all-files

What Happens at Each Commit

After the hooks are installed, git commit automatically runs the configured checks.

All checks pass: Git creates the commit.
A check fixes a file: Review the changes, git add (stage) them again, and retry the commit.
A check reports an error: Read the message, correct the problem, and retry.

For more information, see Git Hooks: Automated Quality Checks.

Verification

[ ] uvx prek install --force completes without an error
[ ] uvx prek run --all-files finishes with all checks passing

If Git hooks cannot be installed

On some restricted machines, Git hooks may not be permitted.

You can continue working without installing the hooks. Run the configured checks manually when possible:

uvx prek run --all-files

Required project checks must still pass before work is considered complete.

If checks fail

Checks may fail on restricted machines where Git hooks cannot be installed. If this occurs, it is safe to skip them and continue with the project.

◄ Back to 🟣 Workflow D