From ddfbcb63f44eb6f379765bf5e44f42189d9012f3 Mon Sep 17 00:00:00 2001 From: Tam Nhu Tran Date: Wed, 22 Apr 2026 15:12:24 -0400 Subject: [PATCH] docs(contrib): align local gate shortcuts --- .github/pull_request_template.md | 2 +- CLAUDE.md | 2 +- README.md | 2 +- docs/code-standards.md | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9002ba3f..c3c6ce9d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ Use what applies. If you skipped something, add a short note instead of forcing it. -- [ ] `bun run format && bun run validate` +- [ ] `bun run format && bun run lint:fix && bun run validate` - [ ] `bun run validate:ci-parity` before requesting review - [ ] `bun run test:e2e` if this PR touches command routing, proxy flows, or workflow/release logic - [ ] `cd ui && bun run validate` if UI changed diff --git a/CLAUDE.md b/CLAUDE.md index ad01f074..f55cc489 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -272,7 +272,7 @@ bun run validate # Step 3: Final check (must pass) - `prepack` runs `build:all` - PR `CI` runs `typecheck`, `lint`, `format`, `build`, `test:all`, and `test:e2e` - `Push CI` runs the same quality suite on `dev` after merge, separate from release publishing -- `Dev Release` still runs build + validate + tests before publishing and still requires `PAT_TOKEN` to push back to protected `dev` +- `Dev Release` still runs build + fast validation + slow tests + e2e before publishing and still requires `PAT_TOKEN` to push back to protected `dev` - husky `pre-commit` runs quick lint/type/format checks - husky `pre-push` runs the full `bun run validate:ci-parity` gate on `main`/`dev`/hotfix branches - husky `pre-push` runs a faster feature-branch gate (`typecheck` + `lint` + `format:check` + `test:fast`) plus targeted checks based on changed files diff --git a/README.md b/README.md index ea2c2617..5a131860 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,7 @@ ccs ollama "summarize these logs" ## Contribute And Report Safely - Contributing guide: [CONTRIBUTING.md](./CONTRIBUTING.md) -- Daily local gate: `bun run format && bun run validate` +- Daily local gate: `bun run format && bun run lint:fix && bun run validate` - Before review or merge confidence: `bun run validate:ci-parity` - If PR checks stay queued for more than 10 minutes, assume the self-hosted runner is offline and notify a maintainer instead of retrying blindly - Starter work: diff --git a/docs/code-standards.md b/docs/code-standards.md index 3c3b35cb..de84eebe 100644 --- a/docs/code-standards.md +++ b/docs/code-standards.md @@ -599,6 +599,7 @@ return ( bun run format bun run lint:fix bun run validate +bun run validate:ci-parity # UI project (if changed) cd ui @@ -611,7 +612,7 @@ bun run validate | Project | Command | Checks | |---------|---------|--------| -| Main | `bun run validate` | typecheck + lint + format:check + test | +| Main | `bun run validate` | typecheck + lint + format:check + test:fast | | UI | `bun run validate` | typecheck + lint + format:check | ---