Skip to content

chore(md): noting pre-commit command #6050

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.

Sign up for GitHub

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

Merged
cmgoffena13 merged 3 commits into from
Sep 15, 2026
+4 −2
Merged

chore(md): noting pre-commit command #6050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b935584
chore(md): noting pre-commit command
cmgoffena13 Sep 10, 2026
1182dd4
chore(docs): aligning docs to CONTRIBUTING on pre-commit behavior
cmgoffena13 Sep 15, 2026
f3add33
Merge branch 'main' into chore/update-contributing
cmgoffena13 Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,12 @@ See [docs/development.md](docs/development.md) for full setup instructions. Key
python -m venv .venv
source .venv/bin/activate
make install-dev
make style # Run before submitting
make style # Run before submitting
make fast-test # Quick test suite
```

Optionally, `make install-pre-commit` installs git hooks so ruff and mypy run on `git commit`. Hooks do not replace `make style`: they run on staged files, while CI runs `make style` across the tree.

## Coding Standards

- Run `make style` before submitting a pull request
Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Once you have activated your virtual environment, you can install the dependenci
make install-dev
```

Optionally, you can use pre-commit to automatically run linters/formatters:
Optionally, `make install-pre-commit` installs git hooks so ruff and mypy run on `git commit`. Hooks do not replace `make style`: they run on staged files, while CI runs `make style` across the tree.

```bash
make install-pre-commit
Expand Down
Loading