docs(ux): mandate full build before PR submission

This commit is contained in:
Keith Guerin
2026-03-31 09:54:17 -07:00
parent 851aff70e6
commit 9bdd895388
2 changed files with 8 additions and 6 deletions
+3 -2
View File
@@ -60,8 +60,9 @@ underlying "rigor."
7. **Keep PRs Small**: ALWAYS aim for under 500 lines of code changed
(excluding snapshots). If a task exceeds this limit, simplify the code, cut
scope, or plan to split it into multiple PRs.
8. **Task Finality**: ALWAYS run `npm run build` or `npm run typecheck` to
verify structural integrity before declaring any task as "complete".
8. **Task Finality**: ALWAYS run `npm run build` and `npm run typecheck` to
verify structural integrity before declaring any task as "complete" or
pushing a PR.
9. **Copyright Headers**: NEVER modify or update the copyright header comments
(e.g., year) in existing files.
@@ -76,14 +76,15 @@ If operating in a sibling worktree (e.g., `feature-xyz/`):
- **Reason**: This prevents macOS-specific icons (like `MAC_TERMINAL_ICON`) from leaking into snapshots, which causes CI failure on Linux runners.
#### **3. Full Validation (No Shortcuts)**
- **Action**: You MUST run the complete validation suite:
- **Action**: You MUST run the complete validation and build suite:
```bash
npm run build
npm run preflight
```
- **Verification**: Run `npm run typecheck` explicitly if `preflight` does not include it, to ensure cross-package integrity.
- **Automated Audit**: You MUST run `/review-frontend <PR_NUMBER>` and address any issues found. This provides an automated audit of your changes to catch common mistakes before a maintainer review.
- **Constraint**: Passing individual tests is NOT enough. `preflight` ensures `tsc --build` passes, catching TypeScript inference bugs that unit tests miss.
- **TDD Fallback**: If `preflight` fails, you must create a local reproduction test before attempting a fix.
- **Automated Audit**: You MUST run `/ux-review <PR_NUMBER>` (or similar audit tool) and address any issues found. This provides an automated audit of your changes to catch common mistakes before a maintainer review.
- **Constraint**: Passing individual tests is NOT enough. `preflight` ensures `tsc --build` passes, catching TypeScript inference bugs that unit tests miss. `npm run build` ensures all packages are successfully bundled for distribution.
- **TDD Fallback**: If `preflight` or `build` fails, you must create a local reproduction test before attempting a fix.
#### **4. UI Dimension Audit**
- **Action**: If Header or Footer height changed, check `packages/cli/src/test-utils/AppRig.tsx`.