Skip to content

Commit 4e23a0b

Browse files
cemililikclaude
andcommitted
docs(tooling): match the hook description to the hook's real scope
Two post-merge review findings on PR #11, both in prose the same PR added. `make hooks` advertised "prettier + next lint under frontend/", which overstates the linter: prettier does run across the workspace, but `next lint` only reaches `frontend/apps/web`, the one package with a `lint` script. CONTRIBUTING called the block above it a "lint / typecheck / test / secret-scan" pass while listing three commands and no secret scan — there is no `make` target for it, and saying so is more useful than implying a missing command. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 4062051 commit 4e23a0b

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,10 @@ The pre-commit hook (activated by `make install`) runs, on staged files only:
103103
`frontend/`**; `next lint --fix` on JS / TS under `frontend/apps/web` — the one
104104
workspace with a `lint` script, so this is exactly what `pnpm -r lint` covers in
105105
CI; and, when the binary is on PATH, `leakwatch scan fs <staged-file>`. So the
106-
lint / typecheck / test / secret-scan pass above is mostly a sanity check. CI
107-
re-runs every check as a hard gate, so a bypassed local commit will fail the PR
108-
build.
106+
three commands above are mostly a sanity check. There is deliberately no
107+
`make secret-scan` to pair with them — the hook and CI are the scanner's only
108+
runners, and CI re-runs every check as a hard gate, so a bypassed local commit
109+
will fail the PR build.
109110

110111
Prettier stops at the `frontend/` boundary, and the root `.prettierignore`
111112
is what enforces it in your editor — `.vscode/settings.json` maps `[markdown]`

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ install: .env hooks ## Restore backend NuGet + frontend pnpm deps + activate git
149149
.PHONY: hooks
150150
hooks: ## Activate the repo's pre-commit hook (.githooks/pre-commit).
151151
@git config core.hooksPath .githooks
152-
@printf "$(CYAN)git hooks → .githooks/ (pre-commit: dotnet format on *.cs, prettier + next lint under frontend/, leakwatch if available)$(RESET)\n"
152+
@printf "$(CYAN)git hooks → .githooks/ (pre-commit: dotnet format *.cs | prettier frontend/ | next lint frontend/apps/web | leakwatch if present)$(RESET)\n"
153153

154154
# ─── Env scaffolding ──────────────────────────────────────────────────────
155155
# `.env` is gitignored; this rule copies `.env.example` on first run so the

0 commit comments

Comments
 (0)