Skip to content

docs: align local verification commands with CI jobs#123

Merged
singyichen merged 1 commit into
mainfrom
docs/verification-ci-alignment
Jul 22, 2026
Merged

docs: align local verification commands with CI jobs#123
singyichen merged 1 commit into
mainfrom
docs/verification-ci-alignment

Conversation

@singyichen

Copy link
Copy Markdown
Owner

Purpose

Make the local verification command list cover every CI job so type/test failures surface before push, not in CI.

Reason

PR #122 failed the "Prototype — Type Check (tsc)" CI job on an error (Object.hasOwn vs lib: ES2020) that no local command could have caught: CLAUDE.md Verification Commands and pr-flow Step 3 listed backend and frontend checks only — design/prototype had CI jobs (typecheck, Playwright) with no local counterpart.

Result

  • CLAUDE.md Verification Commands now includes a Prototype block (pnpm typecheck, pnpm playwright test, run when design/prototype/** changed) and states the alignment rule: every CI job must have a matching local command, added in the same PR that adds the job.
  • pr-flow Step 3 (Test Validation) gains the same prototype commands.

Changed Files

File Change
CLAUDE.md Prototype block in Verification Commands + CI/local alignment rule
.claude/commands/pr-flow.md Prototype typecheck + Playwright added to Step 3

Test Plan

  • Docs-only — both files list identical prototype commands (cross-reference consistency)
  • Commands verified runnable: pnpm typecheck and npx playwright test were executed in design/prototype/ on PR feat: migrate task type taxonomy #122 today

Impact Scope

  • Frontend
  • Admin
  • API
  • Queue
  • Other: project instructions / PR workflow docs

Related

#122 (incident that motivated this)

🤖 Generated with Claude Code

- **Add** prototype typecheck + playwright commands to CLAUDE.md
  Verification Commands and pr-flow Step 3 because the Prototype CI
  jobs had no local counterpart, so an ES2020/ES2022 tsc error on
  PR #122 was first caught in CI instead of before push
- **State** the alignment rule explicitly: every CI job must have a
  matching local command, added in the same PR that adds the job

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@singyichen singyichen added the docs 文件需求/修正 — Documentation additions or fixes label Jul 22, 2026
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation changes correctly implement the stated purpose: aligning local verification commands with CI jobs. Both files now include prototype testing commands (pnpm typecheck and pnpm playwright test) with proper context indicating when to run them. The new alignment rule in CLAUDE.md ensures this pattern is followed for future CI additions. No blocking issues found.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@singyichen
singyichen merged commit 0d452ab into main Jul 22, 2026
10 checks passed
@singyichen
singyichen deleted the docs/verification-ci-alignment branch July 22, 2026 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 文件需求/修正 — Documentation additions or fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant