docs(contrib): align local gate shortcuts

This commit is contained in:
Tam Nhu Tran
2026-04-22 15:12:24 -04:00
parent b314cf353e
commit ddfbcb63f4
4 changed files with 5 additions and 4 deletions
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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:
+2 -1
View File
@@ -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 |
---