From b935584f1d73118b697609c217f2a12f9045ddbb Mon Sep 17 00:00:00 2001 From: Cortland Goffena <30168413+cmgoffena13@users.noreply.github.com> Date: Thu, 10 Sep 2026 15:07:09 -0600 Subject: [PATCH 1/2] chore(md): noting pre-commit command Signed-off-by: Cortland Goffena <30168413+cmgoffena13@users.noreply.github.com> Co-authored-by: Cursor --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c764255a7..4533069d5c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 From 1182dd4986225ce43306e6703134fa09c1a58c04 Mon Sep 17 00:00:00 2001 From: Cortland Goffena <30168413+cmgoffena13@users.noreply.github.com> Date: Mon, 14 Sep 2026 21:33:01 -0600 Subject: [PATCH 2/2] chore(docs): aligning docs to CONTRIBUTING on pre-commit behavior Signed-off-by: Cortland Goffena <30168413+cmgoffena13@users.noreply.github.com> --- docs/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development.md b/docs/development.md index d80ef60689..1f0e111f02 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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