6.2 KiB
Shipping Workflow
This file contains the shipping workflow (Phase 3-4). Load it only when all Phase 2 tasks are complete and execution transitions to quality check.
Phase 3: Quality Check
-
Run Core Quality Checks
Always run before submitting:
# Run full test suite (use project's test command) # Examples: bin/rails test, npm test, pytest, go test, etc. # Run linting (per AGENTS.md) # Use linting-agent before pushing to origin -
Code Review (REQUIRED)
Every change gets reviewed before shipping. The depth scales with the change's risk profile, but review itself is never skipped.
Tier 2: Full review (default) -- REQUIRED unless Tier 1 criteria are explicitly met. Invoke the
ce:reviewskill withmode:autofixto run specialized reviewer agents, auto-apply safe fixes, and surface residual work as todos. When the plan file path is known, pass it asplan:<path>. This is the mandatory default -- proceed to Tier 1 only after confirming every criterion below.Tier 1: Inline self-review -- A lighter alternative permitted only when all four criteria are true. Before choosing Tier 1, explicitly state which criteria apply and why. If any criterion is uncertain, use Tier 2.
- Purely additive (new files only, no existing behavior modified)
- Single concern (one skill, one component -- not cross-cutting)
- Pattern-following (implementation mirrors an existing example with no novel logic)
- Plan-faithful (no scope growth, no deferred questions resolved with surprising answers)
-
Final Validation
- All tasks marked completed
- Testing addressed -- tests pass and new/changed behavior has corresponding test coverage (or an explicit justification for why tests are not needed)
- Linting passes
- Code follows existing patterns
- Figma designs match (if applicable)
- No console errors or warnings
- If the plan has a
Requirements Trace, verify each requirement is satisfied by the completed work - If any
Deferred to Implementationquestions were noted, confirm they were resolved during execution
-
Prepare Operational Validation Plan (REQUIRED)
- Add a
## Post-Deploy Monitoring & Validationsection to the PR description for every change. - Include concrete:
- Log queries/search terms
- Metrics or dashboards to watch
- Expected healthy signals
- Failure signals and rollback/mitigation trigger
- Validation window and owner
- If there is truly no production/runtime impact, still include the section with:
No additional operational monitoring requiredand a one-line reason.
- Add a
Phase 4: Ship It
-
Capture and Upload Screenshots for UI Changes (REQUIRED for any UI work)
For any design changes, new views, or UI modifications, capture and upload screenshots before creating the PR:
Step 1: Start dev server (if not running)
bin/dev # Run in backgroundStep 2: Capture screenshots with agent-browser CLI
agent-browser open http://localhost:3000/[route] agent-browser snapshot -i agent-browser screenshot output.pngSee the
agent-browserskill for detailed usage.Step 3: Upload using imgup skill
skill: imgup # Then upload each screenshot: imgup -h pixhost screenshot.png # pixhost works without API key # Alternative hosts: catbox, imagebin, beeimgWhat to capture:
- New screens: Screenshot of the new UI
- Modified screens: Before AND after screenshots
- Design implementation: Screenshot showing Figma design match
-
Update Plan Status
If the input document has YAML frontmatter with a
statusfield, update it tocompleted:status: active -> status: completed -
Commit and Create Pull Request
Load the
git-commit-push-prskill to handle committing, pushing, and PR creation. The skill handles convention detection, branch safety, logical commit splitting, adaptive PR descriptions, and attribution badges.When providing context for the PR description, include:
- The plan's summary and key decisions
- Testing notes (tests added/modified, manual testing performed)
- Screenshot URLs from step 1 (if applicable)
- Figma design link (if applicable)
- The Post-Deploy Monitoring & Validation section (see Phase 3 Step 4)
If the user prefers to commit without creating a PR, load the
git-commitskill instead. -
Notify User
- Summarize what was completed
- Link to PR (if one was created)
- Note any follow-up work needed
- Suggest next steps if applicable
Quality Checklist
Before creating PR, verify:
- All clarifying questions asked and answered
- All tasks marked completed
- Testing addressed -- tests pass AND new/changed behavior has corresponding test coverage (or an explicit justification for why tests are not needed)
- Linting passes (use linting-agent)
- Code follows existing patterns
- Figma designs match implementation (if applicable)
- Before/after screenshots captured and uploaded (for UI changes)
- Commit messages follow conventional format
- PR description includes Post-Deploy Monitoring & Validation section (or explicit no-impact rationale)
- Code review completed (inline self-review or full
ce:review) - PR description includes summary, testing notes, and screenshots
- PR description includes Compound Engineered badge with accurate model and harness
Code Review Tiers
Every change gets reviewed. The tier determines depth, not whether review happens.
Tier 2 (full review) -- REQUIRED default. Invoke ce:review mode:autofix with plan:<path> when available. Safe fixes are applied automatically; residual work surfaces as todos. Always use this tier unless all four Tier 1 criteria are explicitly confirmed.
Tier 1 (inline self-review) -- permitted only when all four are true (state each explicitly before choosing):
- Purely additive (new files only, no existing behavior modified)
- Single concern (one skill, one component -- not cross-cutting)
- Pattern-following (mirrors an existing example, no novel logic)
- Plan-faithful (no scope growth, no surprising deferred-question resolutions)