mandrel 2.0.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/README.md +59 -28
- package/.agents/agents/acceptance-critic.md +20 -9
- package/.agents/agents/story-worker.md +45 -48
- package/.agents/audit-checklists/performance.md +1 -1
- package/.agents/docs/SDLC.md +60 -46
- package/.agents/docs/agentrc-reference.json +8 -13
- package/.agents/docs/configuration.md +33 -57
- package/.agents/docs/execution-reference.md +39 -10
- package/.agents/docs/quality-gates.md +17 -19
- package/.agents/docs/workflows.md +6 -6
- package/.agents/instructions.md +64 -79
- package/.agents/rules/ci-remediation.md +3 -3
- package/.agents/rules/gherkin-standards.md +10 -0
- package/.agents/rules/git-conventions-reference.md +42 -51
- package/.agents/schemas/acceptance-eval-verdict.schema.json +2 -2
- package/.agents/schemas/agentrc.schema.json +35 -46
- package/.agents/schemas/audit-rules.json +59 -1
- package/.agents/schemas/audit-rules.schema.json +33 -1
- package/.agents/schemas/lifecycle/README.md +1 -2
- package/.agents/schemas/lifecycle/ledger-record.schema.json +1 -1
- package/.agents/schemas/lifecycle/merge.flip-failed.schema.json +33 -0
- package/.agents/schemas/lifecycle/merge.unlanded.schema.json +1 -0
- package/.agents/schemas/lifecycle/story.merged.schema.json +1 -1
- package/.agents/schemas/signal-event.schema.json +3 -3
- package/.agents/schemas/story-deliver-terminal.schema.json +152 -0
- package/.agents/schemas/validation-evidence.schema.json +1 -1
- package/.agents/scripts/acceptance-eval.js +24 -68
- package/.agents/scripts/agents-bootstrap-github.js +1 -1
- package/.agents/scripts/bootstrap.js +3 -3
- package/.agents/scripts/check-dead-exports.js +43 -104
- package/.agents/scripts/check-doc-links.js +2 -2
- package/.agents/scripts/check-lifecycle-lint.js +1 -1
- package/.agents/scripts/check-workflow-cli-lint.js +91 -0
- package/.agents/scripts/deliver-recover.js +122 -0
- package/.agents/scripts/drain-pending-cleanup.js +1 -1
- package/.agents/scripts/evidence-gate.js +20 -50
- package/.agents/scripts/generate-skills-index.js +17 -1
- package/.agents/scripts/generate-workflows-doc.js +4 -4
- package/.agents/scripts/lib/ITicketingProvider.js +1 -19
- package/.agents/scripts/lib/audit-suite/selector.js +323 -23
- package/.agents/scripts/lib/baselines/kinds/maintainability.js +0 -11
- package/.agents/scripts/lib/bootstrap/ci-workflow-template.js +28 -33
- package/.agents/scripts/lib/bootstrap/manifest.js +8 -11
- package/.agents/scripts/lib/bootstrap/project-bootstrap.js +30 -53
- package/.agents/scripts/lib/bootstrap/quality-bootstrap.js +0 -2
- package/.agents/scripts/lib/checks/core-bare-clean.js +4 -1
- package/.agents/scripts/lib/checks/index.js +1 -1
- package/.agents/scripts/lib/checks/loop-health.js +12 -11
- package/.agents/scripts/lib/checks/state.js +17 -248
- package/.agents/scripts/lib/checks/story-init-not-backgrounded.js +3 -3
- package/.agents/scripts/lib/checks/subagent-agent-tool-required.js +3 -4
- package/.agents/scripts/lib/checks/worktree-bootstrap-env.js +2 -2
- package/.agents/scripts/lib/checks/worktree-residue-biome.js +3 -3
- package/.agents/scripts/lib/cli-args.js +23 -2
- package/.agents/scripts/lib/close-validation/gates.js +13 -13
- package/.agents/scripts/lib/close-validation/projections/inputs.js +7 -7
- package/.agents/scripts/lib/close-validation/projections/maintainability.js +12 -12
- package/.agents/scripts/lib/close-validation/runner.js +13 -21
- package/.agents/scripts/lib/close-validation/telemetry.js +17 -8
- package/.agents/scripts/lib/config/acceptance-eval.js +2 -2
- package/.agents/scripts/lib/config/delivery-routing.js +7 -6
- package/.agents/scripts/lib/config/explain.js +10 -16
- package/.agents/scripts/lib/config/github.js +7 -5
- package/.agents/scripts/lib/config/limits.js +15 -25
- package/.agents/scripts/lib/config/quality.js +11 -14
- package/.agents/scripts/lib/config/runners.js +8 -21
- package/.agents/scripts/lib/config/temp-paths.js +18 -56
- package/.agents/scripts/lib/config-settings-schema-delivery.js +34 -16
- package/.agents/scripts/lib/config-settings-schema-quality.js +9 -2
- package/.agents/scripts/lib/config-settings-schema.js +48 -22
- package/.agents/scripts/lib/dead-exports-knip.js +105 -0
- package/.agents/scripts/lib/dead-exports-mode.js +51 -0
- package/.agents/scripts/lib/duplicate-search.js +38 -7
- package/.agents/scripts/lib/findings/promote-finding.js +23 -14
- package/.agents/scripts/lib/format-generated-json.js +97 -0
- package/.agents/scripts/lib/framework-version.js +19 -189
- package/.agents/scripts/lib/gh-exec.js +8 -0
- package/.agents/scripts/lib/git-branch-lifecycle.js +0 -158
- package/.agents/scripts/lib/git-utils.js +0 -14
- package/.agents/scripts/lib/json-utils.js +1 -2
- package/.agents/scripts/lib/label-constants.js +0 -15
- package/.agents/scripts/lib/label-taxonomy.js +1 -12
- package/.agents/scripts/lib/observability/active-story-env.js +42 -163
- package/.agents/scripts/lib/observability/runtime-friction.js +243 -0
- package/.agents/scripts/lib/observability/signal-validator.js +4 -4
- package/.agents/scripts/lib/observability/signals-writer.js +6 -82
- package/.agents/scripts/lib/observability/source-classifier.js +2 -2
- package/.agents/scripts/lib/observability/tool-trace-hook.js +2 -12
- package/.agents/scripts/lib/orchestration/acceptance-clusters.js +1 -1
- package/.agents/scripts/lib/orchestration/acceptance-eval-decision.js +2 -2
- package/.agents/scripts/lib/orchestration/ceremony-routing.js +43 -45
- package/.agents/scripts/lib/orchestration/change-set.js +103 -0
- package/.agents/scripts/lib/orchestration/code-review.js +70 -191
- package/.agents/scripts/lib/orchestration/consolidation-precondition.js +3 -3
- package/.agents/scripts/lib/orchestration/deliver-recover.js +328 -0
- package/.agents/scripts/lib/orchestration/detectors-phase.js +12 -6
- package/.agents/scripts/lib/orchestration/git-cleanup/phases/fast-forward.js +34 -0
- package/.agents/scripts/lib/orchestration/lease-guard-shared.js +3 -2
- package/.agents/scripts/lib/orchestration/lifecycle/emit-ledger-event.js +142 -0
- package/.agents/scripts/lib/orchestration/lifecycle/emit-loop-tick.js +9 -11
- package/.agents/scripts/lib/orchestration/lifecycle/emit-merge-flip-failed.js +86 -0
- package/.agents/scripts/lib/orchestration/lifecycle/emit-merge-unlanded.js +37 -103
- package/.agents/scripts/lib/orchestration/lifecycle/listeners/README.md +7 -3
- package/.agents/scripts/lib/orchestration/lifecycle/listeners/watcher.js +50 -85
- package/.agents/scripts/lib/orchestration/lifecycle/trace-logger.js +3 -14
- package/.agents/scripts/lib/orchestration/merge-block-class.js +76 -20
- package/.agents/scripts/lib/orchestration/merge-poll.js +104 -0
- package/.agents/scripts/lib/orchestration/plan-context.js +116 -33
- package/.agents/scripts/lib/orchestration/plan-critic-conditions.js +26 -36
- package/.agents/scripts/lib/orchestration/plan-critics-evaluate.js +31 -22
- package/.agents/scripts/lib/orchestration/plan-metrics.js +38 -6
- package/.agents/scripts/lib/orchestration/plan-persist/fan-out-gate.js +16 -6
- package/.agents/scripts/lib/orchestration/plan-persist/persist-helpers.js +173 -25
- package/.agents/scripts/lib/orchestration/plan-persist/plan-context-source.js +116 -0
- package/.agents/scripts/lib/orchestration/plan-persist/run-plan-persist.js +280 -100
- package/.agents/scripts/lib/orchestration/plan-persist/story-ops.js +472 -55
- package/.agents/scripts/lib/orchestration/plan-persist/summary.js +21 -16
- package/.agents/scripts/lib/orchestration/plan-persist/supersede-ops.js +509 -0
- package/.agents/scripts/lib/orchestration/plan-text-hygiene.js +230 -0
- package/.agents/scripts/lib/orchestration/planning/authoring-context.js +41 -40
- package/.agents/scripts/lib/orchestration/planning/decomposer-context.js +1 -2
- package/.agents/scripts/lib/orchestration/planning/spec-authoring-grounding.js +1 -1
- package/.agents/scripts/lib/orchestration/resolve-stories.js +344 -0
- package/.agents/scripts/lib/orchestration/retro-proposals.js +7 -7
- package/.agents/scripts/lib/orchestration/review-depth.js +105 -40
- package/.agents/scripts/lib/orchestration/review-providers/findings-renderer.js +3 -13
- package/.agents/scripts/lib/orchestration/review-providers/native.js +1 -154
- package/.agents/scripts/lib/orchestration/review-providers/review-depth.js +3 -2
- package/.agents/scripts/lib/orchestration/review-providers/security-review.js +1 -1
- package/.agents/scripts/lib/orchestration/review-providers/types.js +5 -4
- package/.agents/scripts/lib/orchestration/review-providers/ultrareview.js +1 -1
- package/.agents/scripts/lib/orchestration/run-epilogue.js +374 -16
- package/.agents/scripts/lib/orchestration/single-story-close/phases/auto-merge.js +24 -0
- package/.agents/scripts/lib/orchestration/single-story-close/phases/base-sync.js +11 -9
- package/.agents/scripts/lib/orchestration/single-story-close/phases/close-validation.js +4 -4
- package/.agents/scripts/lib/orchestration/single-story-close/phases/code-review.js +4 -13
- package/.agents/scripts/lib/orchestration/single-story-close/phases/confirm-merge.js +608 -152
- package/.agents/scripts/lib/orchestration/single-story-close/phases/options.js +72 -30
- package/.agents/scripts/lib/orchestration/single-story-close/phases/post-land.js +305 -0
- package/.agents/scripts/lib/orchestration/single-story-close/phases/pull-request.js +1 -1
- package/.agents/scripts/lib/orchestration/single-story-close/phases/review-block.js +12 -8
- package/.agents/scripts/lib/orchestration/single-story-close/phases/worktree-reap.js +37 -4
- package/.agents/scripts/lib/orchestration/single-story-close/phases/wrong-tree-guard.js +2 -2
- package/.agents/scripts/lib/orchestration/single-story-close/runner.js +264 -43
- package/.agents/scripts/lib/orchestration/single-story-lease-guard.js +1 -1
- package/.agents/scripts/lib/orchestration/story-close/format-autofix.js +10 -10
- package/.agents/scripts/lib/orchestration/story-close/phases/code-review.js +104 -279
- package/.agents/scripts/lib/orchestration/story-close/phases/local-lens-review.js +191 -0
- package/.agents/scripts/lib/orchestration/story-close/phases/review-core.js +120 -0
- package/.agents/scripts/lib/orchestration/story-deliver-terminal.js +360 -0
- package/.agents/scripts/lib/orchestration/story-follow-ups.js +75 -14
- package/.agents/scripts/lib/orchestration/story-init-remote.js +12 -8
- package/.agents/scripts/lib/orchestration/story-plan-state.js +14 -29
- package/.agents/scripts/lib/orchestration/task-body-validator.js +52 -7
- package/.agents/scripts/lib/orchestration/ticket-lease.js +27 -74
- package/.agents/scripts/lib/orchestration/ticket-validator-conflicts.js +119 -14
- package/.agents/scripts/lib/orchestration/ticket-validator-sizing.js +3 -4
- package/.agents/scripts/lib/orchestration/ticket-validator.js +121 -18
- package/.agents/scripts/lib/orchestration/ticketing/bulk.js +14 -47
- package/.agents/scripts/lib/orchestration/ticketing/reads.js +19 -32
- package/.agents/scripts/lib/orchestration/ticketing/transition.js +61 -1
- package/.agents/scripts/lib/orchestration/ticketing.js +0 -1
- package/.agents/scripts/lib/plan-phase-cleanup.js +12 -14
- package/.agents/scripts/lib/planning-corpus.js +12 -286
- package/.agents/scripts/lib/preflight-runner.js +2 -2
- package/.agents/scripts/lib/qa/qa-context-hydrator.js +5 -5
- package/.agents/scripts/lib/signals/index.js +4 -17
- package/.agents/scripts/lib/signals/read.js +35 -35
- package/.agents/scripts/lib/signals/schema.js +8 -11
- package/.agents/scripts/lib/signals/span-tree.js +7 -7
- package/.agents/scripts/lib/signals/write.js +0 -1
- package/.agents/scripts/lib/single-story/story-merged-notify.js +13 -2
- package/.agents/scripts/lib/skills/parse-skill.js +16 -3
- package/.agents/scripts/lib/story-adjacency.js +8 -7
- package/.agents/scripts/lib/story-body/story-body.js +81 -13
- package/.agents/scripts/lib/templates/decomposer-prompts.js +15 -16
- package/.agents/scripts/lib/test-env.js +14 -1
- package/.agents/scripts/lib/test-tiers.js +0 -3
- package/.agents/scripts/lib/ticket-body-sections.js +0 -14
- package/.agents/scripts/lib/validation-evidence.js +31 -59
- package/.agents/scripts/lib/wave-runner/live-probe.js +315 -0
- package/.agents/scripts/lib/wave-runner/ready-set.js +32 -6
- package/.agents/scripts/lib/worktree/lifecycle/pending-cleanup.js +1 -1
- package/.agents/scripts/lib/worktree/lifecycle/reap.js +68 -19
- package/.agents/scripts/lib/worktree/lifecycle-manager.js +1 -2
- package/.agents/scripts/plan-context.js +38 -7
- package/.agents/scripts/plan-critics.js +203 -0
- package/.agents/scripts/plan-persist.js +145 -35
- package/.agents/scripts/plan-run-epilogue.js +83 -38
- package/.agents/scripts/post-structured-comment.js +0 -38
- package/.agents/scripts/pr-watch-with-update.js +43 -22
- package/.agents/scripts/providers/github/compose.js +0 -1
- package/.agents/scripts/providers/github/errors.js +0 -19
- package/.agents/scripts/providers/github/issues.js +1 -11
- package/.agents/scripts/providers/github/mappers.js +5 -0
- package/.agents/scripts/providers/github/sub-issues.js +0 -47
- package/.agents/scripts/providers/github/tickets.js +33 -153
- package/.agents/scripts/providers/github.js +17 -6
- package/.agents/scripts/quality-preview.js +13 -6
- package/.agents/scripts/resolve-stories.js +236 -0
- package/.agents/scripts/run-coverage.js +4 -1
- package/.agents/scripts/run-lint.js +2 -2
- package/.agents/scripts/run-verify.js +31 -2
- package/.agents/scripts/signals-view.js +9 -10
- package/.agents/scripts/single-story-close.js +173 -18
- package/.agents/scripts/single-story-confirm-merge.js +288 -15
- package/.agents/scripts/single-story-init.js +6 -10
- package/.agents/scripts/stories-wave-tick.js +380 -53
- package/.agents/scripts/story-plan.js +3 -3
- package/.agents/scripts/update-ticket-state.js +8 -50
- package/.agents/skills/core/code-review-and-quality/SKILL.md +28 -450
- package/.agents/skills/core/code-review-and-quality/reference.md +458 -0
- package/.agents/skills/core/debugging-and-error-recovery/SKILL.md +22 -315
- package/.agents/skills/core/debugging-and-error-recovery/reference.md +323 -0
- package/.agents/skills/core/diagnose-friction/SKILL.md +14 -18
- package/.agents/skills/core/documentation-and-adrs/SKILL.md +25 -397
- package/.agents/skills/core/documentation-and-adrs/reference.md +403 -0
- package/.agents/skills/core/gates-and-baselines/SKILL.md +12 -12
- package/.agents/skills/core/idea-refinement/SKILL.md +3 -3
- package/.agents/skills/core/scope-triage/SKILL.md +3 -0
- package/.agents/skills/core/security-and-hardening/SKILL.md +22 -367
- package/.agents/skills/core/security-and-hardening/reference.md +375 -0
- package/.agents/skills/skills.index.json +2 -12
- package/.agents/skills/stack/qa/playwright-bdd/SKILL.md +2 -4
- package/.agents/skills/stack/qa/qa-explore-driving/SKILL.md +1 -1
- package/.agents/skills/stack/qa/qa-harness/SKILL.md +1 -3
- package/.agents/workflows/audit-architecture.md +3 -4
- package/.agents/workflows/audit-clean-code.md +4 -4
- package/.agents/workflows/audit-documentation.md +4 -5
- package/.agents/workflows/audit-lighthouse.md +8 -0
- package/.agents/workflows/audit-navigability.md +10 -0
- package/.agents/workflows/audit-performance.md +2 -3
- package/.agents/workflows/audit-quality.md +8 -9
- package/.agents/workflows/audit-security.md +1 -2
- package/.agents/workflows/audit-seo.md +10 -0
- package/.agents/workflows/audit-ux-ui.md +7 -0
- package/.agents/workflows/deliver.md +133 -45
- package/.agents/workflows/git-cleanup.md +2 -2
- package/.agents/workflows/git-deliver.md +1 -1
- package/.agents/workflows/helpers/acceptance-self-eval.md +34 -17
- package/.agents/workflows/helpers/code-quality-guardrails.md +15 -12
- package/.agents/workflows/helpers/code-review.md +14 -12
- package/.agents/workflows/helpers/deliver-story-reference.md +73 -32
- package/.agents/workflows/helpers/deliver-story.md +209 -118
- package/.agents/workflows/helpers/parallel-tooling.md +2 -2
- package/.agents/workflows/helpers/worktree-lifecycle.md +28 -32
- package/.agents/workflows/plan.md +239 -19
- package/.agents/workflows/qa-assist.md +6 -6
- package/.agents/workflows/qa-explore.md +3 -3
- package/.agents/workflows/qa-run.md +1 -5
- package/bin/mandrel.js +12 -1
- package/docs/CHANGELOG.md +62 -0
- package/lib/cli/registry.js +262 -19
- package/lib/cli/sync-agents.js +157 -0
- package/lib/cli/sync-commands.js +115 -6
- package/lib/cli/sync.js +168 -6
- package/lib/cli/update.js +105 -8
- package/lib/cli/version-helpers.js +131 -0
- package/lib/migrations/README.md +7 -5
- package/lib/migrations/index.js +17 -9
- package/lib/migrations/steps/2.1.0-retire-mi-drop-knobs.js +100 -0
- package/lib/migrations/steps/2.1.0-retire-verify-concurrency-cap.js +101 -0
- package/lib/migrations/steps/2.2.0-retire-epic-ac-tags.js +154 -0
- package/package.json +2 -2
- package/.agents/schemas/epic-perf-report.schema.json +0 -89
- package/.agents/schemas/lifecycle/acceptance.reconcile.failed.schema.json +0 -13
- package/.agents/schemas/lifecycle/acceptance.reconcile.ok.schema.json +0 -13
- package/.agents/schemas/lifecycle/acceptance.reconcile.skipped.schema.json +0 -13
- package/.agents/schemas/lifecycle/acceptance.reconcile.start.schema.json +0 -12
- package/.agents/schemas/lifecycle/acceptance.reconcile.waived.schema.json +0 -13
- package/.agents/schemas/lifecycle/epic.automerge.end.schema.json +0 -15
- package/.agents/schemas/lifecycle/epic.automerge.start.schema.json +0 -13
- package/.agents/schemas/lifecycle/epic.blocked.schema.json +0 -13
- package/.agents/schemas/lifecycle/epic.cleanup.end.schema.json +0 -12
- package/.agents/schemas/lifecycle/epic.cleanup.start.schema.json +0 -12
- package/.agents/schemas/lifecycle/epic.close.end.schema.json +0 -12
- package/.agents/schemas/lifecycle/epic.complete.schema.json +0 -13
- package/.agents/schemas/lifecycle/epic.finalize.end.schema.json +0 -13
- package/.agents/schemas/lifecycle/epic.finalize.start.schema.json +0 -12
- package/.agents/schemas/lifecycle/epic.merge.armed.schema.json +0 -13
- package/.agents/schemas/lifecycle/epic.merge.blocked.schema.json +0 -14
- package/.agents/schemas/lifecycle/epic.merge.confirmed.schema.json +0 -17
- package/.agents/schemas/lifecycle/epic.merge.ready.schema.json +0 -15
- package/.agents/schemas/lifecycle/epic.plan.end.schema.json +0 -18
- package/.agents/schemas/lifecycle/epic.plan.start.schema.json +0 -12
- package/.agents/schemas/lifecycle/epic.snapshot.end.schema.json +0 -16
- package/.agents/schemas/lifecycle/epic.snapshot.start.schema.json +0 -12
- package/.agents/schemas/lifecycle/epic.watch.end.schema.json +0 -29
- package/.agents/schemas/lifecycle/epic.watch.start.schema.json +0 -16
- package/.agents/schemas/lifecycle/story.heartbeat.schema.json +0 -20
- package/.agents/schemas/risk-verdict.schema.json +0 -53
- package/.agents/schemas/story-perf-summary.schema.json +0 -73
- package/.agents/scripts/analyze-execution.js +0 -444
- package/.agents/scripts/check-prepush-recovery.js +0 -90
- package/.agents/scripts/lib/git-merge-orchestrator.js +0 -261
- package/.agents/scripts/lib/observability/baseline-refresh-rate.js +0 -221
- package/.agents/scripts/lib/observability/hook-heartbeat.js +0 -187
- package/.agents/scripts/lib/observability/perf-aggregator.js +0 -813
- package/.agents/scripts/lib/observability/perf-report-readers.js +0 -328
- package/.agents/scripts/lib/observability/perf-report-render.js +0 -182
- package/.agents/scripts/lib/orchestration/audit-lens-routing.js +0 -128
- package/.agents/scripts/lib/orchestration/bookkeeping-outbox.js +0 -273
- package/.agents/scripts/lib/orchestration/error-journal.js +0 -139
- package/.agents/scripts/lib/orchestration/lifecycle/emit-story-heartbeat.js +0 -155
- package/.agents/scripts/lib/orchestration/lifecycle/ledger-diff.js +0 -140
- package/.agents/scripts/lib/orchestration/lifecycle/listeners/merge-watcher.js +0 -665
- package/.agents/scripts/lib/orchestration/plan-review-routing.js +0 -63
- package/.agents/scripts/lib/orchestration/planning/risk-verdict.js +0 -104
- package/.agents/scripts/lib/orchestration/planning-context-budget.js +0 -213
- package/.agents/scripts/lib/orchestration/planning-risk.js +0 -194
- package/.agents/scripts/lib/orchestration/post-merge/phases/branch-cleanup.js +0 -56
- package/.agents/scripts/lib/orchestration/post-merge/phases/dashboard-refresh.js +0 -21
- package/.agents/scripts/lib/orchestration/post-merge/phases/notification.js +0 -78
- package/.agents/scripts/lib/orchestration/post-merge/phases/temp-cleanup.js +0 -68
- package/.agents/scripts/lib/orchestration/post-merge/phases/ticket-closure.js +0 -118
- package/.agents/scripts/lib/orchestration/post-merge/phases/worktree-reap.js +0 -397
- package/.agents/scripts/lib/orchestration/preflight-cache.js +0 -187
- package/.agents/scripts/lib/orchestration/resolve-plan-run.js +0 -155
- package/.agents/scripts/lib/orchestration/retro-perf-heuristics.js +0 -275
- package/.agents/scripts/lib/orchestration/story-progress/story-run-progress-writer.js +0 -400
- package/.agents/scripts/lib/single-story/confirm-merge-follow-ups.js +0 -36
- package/.agents/scripts/resolve-plan-run.js +0 -117
- package/.agents/skills/core/analyze-execution/SKILL.md +0 -101
|
@@ -8,15 +8,7 @@
|
|
|
8
8
|
import { parseArgs } from 'node:util';
|
|
9
9
|
import { resolveConfig } from './lib/config-resolver.js';
|
|
10
10
|
import { Logger } from './lib/Logger.js';
|
|
11
|
-
import {
|
|
12
|
-
enqueueLabel,
|
|
13
|
-
outboxPathFor,
|
|
14
|
-
} from './lib/orchestration/bookkeeping-outbox.js';
|
|
15
|
-
import {
|
|
16
|
-
cascadeCompletion,
|
|
17
|
-
STATE_LABELS,
|
|
18
|
-
transitionTicketState,
|
|
19
|
-
} from './lib/orchestration/ticketing.js';
|
|
11
|
+
import { transitionTicketState } from './lib/orchestration/ticketing.js';
|
|
20
12
|
import { createProvider } from './lib/provider-factory.js';
|
|
21
13
|
|
|
22
14
|
// ── CLI Main Block ────────────────────────────────────────────────────────
|
|
@@ -31,8 +23,6 @@ if (
|
|
|
31
23
|
ticket: { type: 'string' },
|
|
32
24
|
state: { type: 'string' },
|
|
33
25
|
'remove-label': { type: 'string' },
|
|
34
|
-
buffer: { type: 'boolean' },
|
|
35
|
-
epic: { type: 'string' },
|
|
36
26
|
},
|
|
37
27
|
strict: false,
|
|
38
28
|
});
|
|
@@ -66,50 +56,18 @@ if (
|
|
|
66
56
|
return;
|
|
67
57
|
}
|
|
68
58
|
|
|
69
|
-
// Headless buffering (Epic #4476 M5): buffer an intermediate state flip to
|
|
70
|
-
// the per-Epic outbox instead of a live GitHub round-trip; finalize's
|
|
71
|
-
// bookkeeping-reconcile.js drains it once. `agent::blocked` (the HITL gate,
|
|
72
|
-
// §1.J) and `agent::done` (its cascade must run live) ALWAYS surface
|
|
73
|
-
// immediately and are never buffered. Requires --epic to locate the outbox.
|
|
74
|
-
if (
|
|
75
|
-
values.buffer &&
|
|
76
|
-
state !== STATE_LABELS.BLOCKED &&
|
|
77
|
-
state !== STATE_LABELS.DONE
|
|
78
|
-
) {
|
|
79
|
-
const epicId = Number.parseInt(values.epic ?? '', 10);
|
|
80
|
-
if (!Number.isInteger(epicId) || epicId <= 0) {
|
|
81
|
-
throw new Error('--buffer requires --epic <id>');
|
|
82
|
-
}
|
|
83
|
-
enqueueLabel({
|
|
84
|
-
outboxPath: outboxPathFor(epicId, config),
|
|
85
|
-
ticketId,
|
|
86
|
-
state,
|
|
87
|
-
});
|
|
88
|
-
Logger.info(
|
|
89
|
-
`[State-Sync] Buffered #${ticketId} → ${state} (headless; drained at finalize)`,
|
|
90
|
-
);
|
|
91
|
-
return;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
59
|
Logger.info(
|
|
95
60
|
`[State-Sync] Transitioning ticket #${ticketId} to ${state}...`,
|
|
96
61
|
);
|
|
62
|
+
// Story #4545 — no second cascade here. `transitionTicketState` already
|
|
63
|
+
// fires the upward cascade on every transition (bulk.js registers
|
|
64
|
+
// `cascadeParentState` as transition.js's cascade runner, and the DONE
|
|
65
|
+
// branch delegates to `cascadeCompletion`), so the explicit call this
|
|
66
|
+
// used to make re-walked the same parents and re-spent the same API
|
|
67
|
+
// calls a second time on every done transition — under a Story-only
|
|
68
|
+
// model where no orchestration parent exists to find.
|
|
97
69
|
await transitionTicketState(provider, ticketId, state);
|
|
98
70
|
|
|
99
|
-
if (state === STATE_LABELS.DONE) {
|
|
100
|
-
Logger.info(`[State-Sync] Cascading completion from #${ticketId}...`);
|
|
101
|
-
const cascade = await cascadeCompletion(provider, ticketId);
|
|
102
|
-
// Hoisted out of the `for...of` initializer because typhonjs-escomplex
|
|
103
|
-
// mis-parses optional chaining there (it would zero out this file's
|
|
104
|
-
// maintainability score).
|
|
105
|
-
const cascadeFailures = cascade?.failed ?? [];
|
|
106
|
-
for (const { parentId, error } of cascadeFailures) {
|
|
107
|
-
Logger.warn(
|
|
108
|
-
`[State-Sync] ⚠️ Cascade partial-failure on parent #${parentId}: ${error}`,
|
|
109
|
-
);
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
|
|
113
71
|
// Optional secondary label removal alongside the state transition
|
|
114
72
|
// (e.g. clear `status::blocked` when transitioning back to ready).
|
|
115
73
|
if (removeLabel) {
|
|
@@ -25,453 +25,31 @@ description:
|
|
|
25
25
|
- **Refactoring is post-green and behaviour-preserving.** Run the refactor pass only when the suite is already green and gates pass; inputs, outputs, side effects, error semantics, and ordering MUST be identical before and after, and existing tests MUST keep passing **without modification** (if a test had to change, behaviour changed — revert).
|
|
26
26
|
- **Lower CRAP by lowering complexity, and remove duplication at the root.** Target the highest-CRAP well-covered functions and the largest verbatim duplications by measurement (`check-baselines.js`), not by smell; extract one well-named helper rather than leaving near-copies. CRAP must not rise and maintainability must not fall on any touched file, and no gate, floor, or threshold may be retuned to make the pass "succeed".
|
|
27
27
|
|
|
28
|
-
##
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
- Does it match the spec or task requirements?
|
|
57
|
-
- Are edge cases handled (null, empty, boundary values)?
|
|
58
|
-
- Are error paths handled (not just the happy path)?
|
|
59
|
-
- Does it pass all tests? Are the tests actually testing the right things?
|
|
60
|
-
- Are there off-by-one errors, race conditions, or state inconsistencies?
|
|
61
|
-
|
|
62
|
-
### 2. Readability & Simplicity
|
|
63
|
-
|
|
64
|
-
Can another engineer (or agent) understand this code without the author
|
|
65
|
-
explaining it?
|
|
66
|
-
|
|
67
|
-
- Are names descriptive and consistent with project conventions? (No `temp`,
|
|
68
|
-
`data`, `result` without context)
|
|
69
|
-
- Is the control flow straightforward (avoid nested ternaries, deep callbacks)?
|
|
70
|
-
- Is the code organized logically (related code grouped, clear module
|
|
71
|
-
boundaries)?
|
|
72
|
-
- Are there any "clever" tricks that should be simplified?
|
|
73
|
-
- **Could this be done in fewer lines?** (1000 lines where 100 suffice is a
|
|
74
|
-
failure)
|
|
75
|
-
- **Are abstractions earning their complexity?** (Don't generalize until the
|
|
76
|
-
third use case)
|
|
77
|
-
- Would comments help clarify non-obvious intent? (But don't comment obvious
|
|
78
|
-
code.)
|
|
79
|
-
- Are there dead code artifacts: no-op variables (`_unused`), backwards-compat
|
|
80
|
-
shims, or `// removed` comments?
|
|
81
|
-
|
|
82
|
-
### 3. Architecture
|
|
83
|
-
|
|
84
|
-
Does the change fit the system's design?
|
|
85
|
-
|
|
86
|
-
- Does it follow existing patterns or introduce a new one? If new, is it
|
|
87
|
-
justified?
|
|
88
|
-
- Does it maintain clean module boundaries?
|
|
89
|
-
- Is there code duplication that should be shared?
|
|
90
|
-
- Are dependencies flowing in the right direction (no circular dependencies)?
|
|
91
|
-
- Is the abstraction level appropriate (not over-engineered, not too coupled)?
|
|
92
|
-
|
|
93
|
-
### 4. Security
|
|
94
|
-
|
|
95
|
-
For detailed security guidance, see `security-and-hardening`. Does the change
|
|
96
|
-
introduce vulnerabilities?
|
|
97
|
-
|
|
98
|
-
- Is user input validated and sanitized?
|
|
99
|
-
- Are secrets kept out of code, logs, and version control?
|
|
100
|
-
- Is authentication/authorization checked where needed?
|
|
101
|
-
- Are SQL queries parameterized (no string concatenation)?
|
|
102
|
-
- Are outputs encoded to prevent XSS?
|
|
103
|
-
- Are dependencies from trusted sources with no known vulnerabilities?
|
|
104
|
-
- Is data from external sources (APIs, logs, user content, config files) treated
|
|
105
|
-
as untrusted?
|
|
106
|
-
- Are external data flows validated at system boundaries before use in logic or
|
|
107
|
-
rendering?
|
|
108
|
-
|
|
109
|
-
### 5. Performance
|
|
110
|
-
|
|
111
|
-
Measure before optimizing, and only on the hot path. Does the change introduce
|
|
112
|
-
performance problems?
|
|
113
|
-
|
|
114
|
-
- Any N+1 query patterns?
|
|
115
|
-
- Any unbounded loops or unconstrained data fetching?
|
|
116
|
-
- Any synchronous operations that should be async?
|
|
117
|
-
- Any unnecessary re-renders in UI components?
|
|
118
|
-
- Any missing pagination on list endpoints?
|
|
119
|
-
- Any large objects created in hot paths?
|
|
120
|
-
|
|
121
|
-
## Change Sizing
|
|
122
|
-
|
|
123
|
-
Small, focused changes are easier to review, faster to merge, and safer to
|
|
124
|
-
deploy. Target these sizes:
|
|
125
|
-
|
|
126
|
-
```text
|
|
127
|
-
~100 lines changed → Good. Reviewable in one sitting.
|
|
128
|
-
~300 lines changed → Acceptable if it's a single logical change.
|
|
129
|
-
~1000 lines changed → Too large. Split it.
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
**What counts as "one change":** A single self-contained modification that
|
|
133
|
-
addresses one thing, includes related tests, and keeps the system functional
|
|
134
|
-
after submission. One part of a feature — not the whole feature.
|
|
135
|
-
|
|
136
|
-
**Splitting strategies when a change is too large:**
|
|
137
|
-
|
|
138
|
-
| Strategy | How | When |
|
|
139
|
-
| ----------------- | ------------------------------------------------------- | ----------------------- |
|
|
140
|
-
| **Stack** | Submit a small change, start the next one based on it | Sequential dependencies |
|
|
141
|
-
| **By file group** | Separate changes for groups needing different reviewers | Cross-cutting concerns |
|
|
142
|
-
| **Horizontal** | Create shared code/stubs first, then consumers | Layered architecture |
|
|
143
|
-
| **Vertical** | Break into smaller full-stack slices of the feature | Feature work |
|
|
144
|
-
|
|
145
|
-
**When large changes are acceptable:** Complete file deletions and automated
|
|
146
|
-
refactoring where the reviewer only needs to verify intent, not every line.
|
|
147
|
-
|
|
148
|
-
**Separate refactoring from feature work.** A change that refactors existing
|
|
149
|
-
code and adds new behavior is two changes — submit them separately. Small
|
|
150
|
-
cleanups (variable renaming) can be included at reviewer discretion.
|
|
151
|
-
|
|
152
|
-
## Change Descriptions
|
|
153
|
-
|
|
154
|
-
Every change needs a description that stands alone in version control history.
|
|
155
|
-
|
|
156
|
-
**First line:** Short, imperative, standalone. "Delete the FizzBuzz RPC" not
|
|
157
|
-
"Deleting the FizzBuzz RPC." Must be informative enough that someone searching
|
|
158
|
-
history can understand the change without reading the diff.
|
|
159
|
-
|
|
160
|
-
**Body:** What is changing and why. Include context, decisions, and reasoning
|
|
161
|
-
not visible in the code itself. Link to bug numbers, benchmark results, or
|
|
162
|
-
design docs where relevant. Acknowledge approach shortcomings when they exist.
|
|
163
|
-
|
|
164
|
-
**Anti-patterns:** "Fix bug," "Fix build," "Add patch," "Moving code from A to
|
|
165
|
-
B," "Phase 1," "Add convenience functions."
|
|
166
|
-
|
|
167
|
-
## Review Process
|
|
168
|
-
|
|
169
|
-
### Step 1: Understand the Context
|
|
170
|
-
|
|
171
|
-
Before looking at code, understand the intent:
|
|
172
|
-
|
|
173
|
-
```text
|
|
174
|
-
- What is this change trying to accomplish?
|
|
175
|
-
- What spec or task does it implement?
|
|
176
|
-
- What is the expected behavior change?
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
### Step 2: Review the Tests First
|
|
180
|
-
|
|
181
|
-
Tests reveal intent and coverage:
|
|
182
|
-
|
|
183
|
-
```text
|
|
184
|
-
- Do tests exist for the change?
|
|
185
|
-
- Do they test behavior (not implementation details)?
|
|
186
|
-
- Are edge cases covered?
|
|
187
|
-
- Do tests have descriptive names?
|
|
188
|
-
- Would the tests catch a regression if the code changed?
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
### Step 3: Review the Implementation
|
|
192
|
-
|
|
193
|
-
Walk through the code with the five axes in mind:
|
|
194
|
-
|
|
195
|
-
```text
|
|
196
|
-
For each file changed:
|
|
197
|
-
1. Correctness: Does this code do what the test says it should?
|
|
198
|
-
2. Readability: Can I understand this without help?
|
|
199
|
-
3. Architecture: Does this fit the system?
|
|
200
|
-
4. Security: Any vulnerabilities?
|
|
201
|
-
5. Performance: Any bottlenecks?
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
### Step 4: Categorize Findings
|
|
205
|
-
|
|
206
|
-
Label every comment with its severity so the author knows what's required vs
|
|
207
|
-
optional:
|
|
208
|
-
|
|
209
|
-
| Prefix | Meaning | Author Action |
|
|
210
|
-
| ----------------------------- | ------------------ | ------------------------------------------------------- |
|
|
211
|
-
| _(no prefix)_ | Required change | Must address before merge |
|
|
212
|
-
| **Critical:** | Blocks merge | Security vulnerability, data loss, broken functionality |
|
|
213
|
-
| **Nit:** | Minor, optional | Author may ignore — formatting, style preferences |
|
|
214
|
-
| **Optional:** / **Consider:** | Suggestion | Worth considering but not required |
|
|
215
|
-
| **FYI** | Informational only | No action needed — context for future reference |
|
|
216
|
-
|
|
217
|
-
This prevents authors from treating all feedback as mandatory and wasting time
|
|
218
|
-
on optional suggestions.
|
|
219
|
-
|
|
220
|
-
### Step 5: Verify the Verification
|
|
221
|
-
|
|
222
|
-
Check the author's verification story:
|
|
223
|
-
|
|
224
|
-
```text
|
|
225
|
-
- What tests were run?
|
|
226
|
-
- Did the build pass?
|
|
227
|
-
- Was the change tested manually?
|
|
228
|
-
- Are there screenshots for UI changes?
|
|
229
|
-
- Is there a before/after comparison?
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
## Multi-Model Review Pattern
|
|
233
|
-
|
|
234
|
-
Use different models for different review perspectives:
|
|
235
|
-
|
|
236
|
-
```text
|
|
237
|
-
Model A writes the code
|
|
238
|
-
│
|
|
239
|
-
▼
|
|
240
|
-
Model B reviews for correctness and architecture
|
|
241
|
-
│
|
|
242
|
-
▼
|
|
243
|
-
Model A addresses the feedback
|
|
244
|
-
│
|
|
245
|
-
▼
|
|
246
|
-
Human makes the final call
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
This catches issues that a single model might miss — different models have
|
|
250
|
-
different blind spots.
|
|
251
|
-
|
|
252
|
-
**Example prompt for a review agent:**
|
|
253
|
-
|
|
254
|
-
```text
|
|
255
|
-
Review this code change for correctness, security, and adherence to
|
|
256
|
-
our project conventions. The spec says [X]. The change should [Y].
|
|
257
|
-
Flag any issues as Critical, Important, or Suggestion.
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
## Dead Code Hygiene
|
|
261
|
-
|
|
262
|
-
After any refactoring or implementation change, check for orphaned code:
|
|
263
|
-
|
|
264
|
-
1. Identify code that is now unreachable or unused
|
|
265
|
-
2. List it explicitly
|
|
266
|
-
3. **Ask before deleting:** "Should I remove these now-unused elements: [list]?"
|
|
267
|
-
|
|
268
|
-
Don't leave dead code lying around — it confuses future readers and agents. But
|
|
269
|
-
don't silently delete things you're not sure about. When in doubt, ask.
|
|
270
|
-
|
|
271
|
-
```text
|
|
272
|
-
DEAD CODE IDENTIFIED:
|
|
273
|
-
- formatLegacyDate() in src/utils/date.ts — replaced by formatDate()
|
|
274
|
-
- OldTaskCard component in src/components/ — replaced by TaskCard
|
|
275
|
-
- LEGACY_API_URL constant in src/config.ts — no remaining references
|
|
276
|
-
→ Safe to remove these?
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
## Review Speed
|
|
280
|
-
|
|
281
|
-
Slow reviews block entire teams. The cost of context-switching to review is less
|
|
282
|
-
than the waiting cost imposed on others.
|
|
283
|
-
|
|
284
|
-
- **Respond within one business day** — this is the maximum, not the target
|
|
285
|
-
- **Ideal cadence:** Respond shortly after a review request arrives, unless deep
|
|
286
|
-
in focused coding. A typical change should complete multiple review rounds in
|
|
287
|
-
a single day
|
|
288
|
-
- **Prioritize fast individual responses** over quick final approval. Quick
|
|
289
|
-
feedback reduces frustration even if multiple rounds are needed
|
|
290
|
-
- **Large changes:** Ask the author to split them rather than reviewing one
|
|
291
|
-
massive changeset
|
|
292
|
-
|
|
293
|
-
## Handling Disagreements
|
|
294
|
-
|
|
295
|
-
When resolving review disputes, apply this hierarchy:
|
|
296
|
-
|
|
297
|
-
1. **Technical facts and data** override opinions and preferences
|
|
298
|
-
2. **Style guides** are the absolute authority on style matters
|
|
299
|
-
3. **Software design** must be evaluated on engineering principles, not personal
|
|
300
|
-
preference
|
|
301
|
-
4. **Codebase consistency** is acceptable if it doesn't degrade overall health
|
|
302
|
-
|
|
303
|
-
**Don't accept "I'll clean it up later."** Experience shows deferred cleanup
|
|
304
|
-
rarely happens. Require cleanup before submission unless it's a genuine
|
|
305
|
-
emergency. If surrounding issues can't be addressed in this change, require
|
|
306
|
-
filing a bug with self-assignment.
|
|
307
|
-
|
|
308
|
-
## Honesty in Review
|
|
309
|
-
|
|
310
|
-
When reviewing code — whether written by you, another agent, or a human:
|
|
311
|
-
|
|
312
|
-
- **Don't rubber-stamp.** "LGTM" without evidence of review helps no one.
|
|
313
|
-
- **Don't soften real issues.** "This might be a minor concern" when it's a bug
|
|
314
|
-
that will hit production is dishonest.
|
|
315
|
-
- **Quantify problems when possible.** "This N+1 query will add ~50ms per item
|
|
316
|
-
in the list" is better than "this could be slow."
|
|
317
|
-
- **Push back on approaches with clear problems.** Sycophancy is a failure mode
|
|
318
|
-
in reviews. If the implementation has issues, say so directly and propose
|
|
319
|
-
alternatives.
|
|
320
|
-
- **Accept override gracefully.** If the author has full context and disagrees,
|
|
321
|
-
defer to their judgment. Comment on code, not people — reframe personal
|
|
322
|
-
critiques to focus on the code itself.
|
|
323
|
-
|
|
324
|
-
## Dependency Discipline
|
|
325
|
-
|
|
326
|
-
Part of code review is dependency review:
|
|
327
|
-
|
|
328
|
-
**Before adding any dependency:**
|
|
329
|
-
|
|
330
|
-
1. Does the existing stack solve this? (Often it does.)
|
|
331
|
-
2. How large is the dependency? (Check bundle impact.)
|
|
332
|
-
3. Is it actively maintained? (Check last commit, open issues.)
|
|
333
|
-
4. Does it have known vulnerabilities? (`npm audit`)
|
|
334
|
-
5. What's the license? (Must be compatible with the project.)
|
|
335
|
-
|
|
336
|
-
**Rule:** Prefer standard library and existing utilities over new dependencies.
|
|
337
|
-
Every dependency is a liability.
|
|
338
|
-
|
|
339
|
-
## The Review Checklist
|
|
340
|
-
|
|
341
|
-
```markdown
|
|
342
|
-
## Review: [PR/Change title]
|
|
343
|
-
|
|
344
|
-
### Context
|
|
345
|
-
|
|
346
|
-
- [ ] I understand what this change does and why
|
|
347
|
-
|
|
348
|
-
### Correctness
|
|
349
|
-
|
|
350
|
-
- [ ] Change matches spec/task requirements
|
|
351
|
-
- [ ] Edge cases handled
|
|
352
|
-
- [ ] Error paths handled
|
|
353
|
-
- [ ] Tests cover the change adequately
|
|
354
|
-
|
|
355
|
-
### Readability
|
|
356
|
-
|
|
357
|
-
- [ ] Names are clear and consistent
|
|
358
|
-
- [ ] Logic is straightforward
|
|
359
|
-
- [ ] No unnecessary complexity
|
|
360
|
-
|
|
361
|
-
### Architecture
|
|
362
|
-
|
|
363
|
-
- [ ] Follows existing patterns
|
|
364
|
-
- [ ] No unnecessary coupling or dependencies
|
|
365
|
-
- [ ] Appropriate abstraction level
|
|
366
|
-
|
|
367
|
-
### Security
|
|
368
|
-
|
|
369
|
-
- [ ] No secrets in code
|
|
370
|
-
- [ ] Input validated at boundaries
|
|
371
|
-
- [ ] No injection vulnerabilities
|
|
372
|
-
- [ ] Auth checks in place
|
|
373
|
-
- [ ] External data sources treated as untrusted
|
|
374
|
-
|
|
375
|
-
### Performance
|
|
376
|
-
|
|
377
|
-
- [ ] No N+1 patterns
|
|
378
|
-
- [ ] No unbounded operations
|
|
379
|
-
- [ ] Pagination on list endpoints
|
|
380
|
-
|
|
381
|
-
### Verification
|
|
382
|
-
|
|
383
|
-
- [ ] Tests pass
|
|
384
|
-
- [ ] Build succeeds
|
|
385
|
-
- [ ] Manual verification done (if applicable)
|
|
386
|
-
|
|
387
|
-
### Verdict
|
|
388
|
-
|
|
389
|
-
- [ ] **Approve** — Ready to merge
|
|
390
|
-
- [ ] **Request changes** — Issues must be addressed
|
|
391
|
-
```
|
|
392
|
-
|
|
393
|
-
## Common Rationalizations
|
|
394
|
-
|
|
395
|
-
| Rationalization | Reality |
|
|
396
|
-
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
|
|
397
|
-
| "It works, that's good enough" | Working code that's unreadable, insecure, or architecturally wrong creates debt that compounds. |
|
|
398
|
-
| "I wrote it, so I know it's correct" | Authors are blind to their own assumptions. Every change benefits from another set of eyes. |
|
|
399
|
-
| "We'll clean it up later" | Later never comes. The review is the quality gate — use it. Require cleanup before merge, not after. |
|
|
400
|
-
| "AI-generated code is probably fine" | AI code needs more scrutiny, not less. It's confident and plausible, even when wrong. |
|
|
401
|
-
| "The tests pass, so it's good" | Tests are necessary but not sufficient. They don't catch architecture problems, security issues, or readability concerns. |
|
|
402
|
-
|
|
403
|
-
## Red Flags
|
|
404
|
-
|
|
405
|
-
- PRs merged without any review
|
|
406
|
-
- Review that only checks if tests pass (ignoring other axes)
|
|
407
|
-
- "LGTM" without evidence of actual review
|
|
408
|
-
- Security-sensitive changes without security-focused review
|
|
409
|
-
- Large PRs that are "too big to review properly" (split them)
|
|
410
|
-
- No regression tests with bug fix PRs
|
|
411
|
-
- Review comments without severity labels — makes it unclear what's required vs
|
|
412
|
-
optional
|
|
413
|
-
- Accepting "I'll fix it later" — it never happens
|
|
414
|
-
|
|
415
|
-
## Post-Green Refactor Pass
|
|
416
|
-
|
|
417
|
-
Review's sibling discipline is the **behaviour-preserving refactor** that drives
|
|
418
|
-
CRAP (Change Risk Anti-Patterns) and duplication down _after_ the code is green
|
|
419
|
-
— the pass wired in as the opt-in `delivery.refactorStage` checkpoint. It
|
|
420
|
-
optimises for the measured CRAP and duplication axes the baselines ratchet, not
|
|
421
|
-
for subjective readability, and it never runs from red.
|
|
422
|
-
|
|
423
|
-
**When to run:** a baseline report flags a high-CRAP function that is already
|
|
424
|
-
well-covered (so the lever is complexity, not coverage); the same logic is
|
|
425
|
-
duplicated across two or more files and the copies are drifting; or the
|
|
426
|
-
`delivery.refactorStage` checkpoint fires after gates pass and before a Story
|
|
427
|
-
closes. **When NOT to:** before tests are green (write/fix tests first), or when
|
|
428
|
-
a function's CRAP is high because it is _uncovered_ — that is a missing-test
|
|
429
|
-
problem, so drive it with the TDD cycle in
|
|
430
|
-
[`.agents/rules/testing-standards.md`](../../../rules/testing-standards.md).
|
|
431
|
-
|
|
432
|
-
```text
|
|
433
|
-
Confirm green + baseline → pick highest-CRAP / largest dup
|
|
434
|
-
▲ │
|
|
435
|
-
│ ▼
|
|
436
|
-
re-run gates, confirm ◄── refactor ◄── comprehend the target
|
|
437
|
-
CRAP↓ / maint↑, tests pass (one change) (call sites + tests)
|
|
438
|
-
```
|
|
439
|
-
|
|
440
|
-
1. **Baseline.** Confirm green and capture current CRAP and maintainability
|
|
441
|
-
(`node .agents/scripts/check-baselines.js`) — your do-no-harm reference.
|
|
442
|
-
2. **Target by measurement.** Pick the highest-CRAP well-covered function, or
|
|
443
|
-
the largest verbatim duplication. Work worst-first.
|
|
444
|
-
3. **Comprehend before you touch (Chesterton's Fence).** Read the call sites and
|
|
445
|
-
the tests that pin the behaviour first; an "unnecessary" abstraction may
|
|
446
|
-
exist for testability or extensibility.
|
|
447
|
-
4. **Refactor one step.** Extract a focused function, flatten nesting into guard
|
|
448
|
-
clauses, replace a nested ternary / boolean-flag param, or extract a single
|
|
449
|
-
shared helper for the duplication (dedup the _behaviour_, not just the text —
|
|
450
|
-
look-alike blocks that encode different responsibilities stay separate).
|
|
451
|
-
5. **Verify.** Re-run the affected tests (unmodified) and the baselines. CRAP
|
|
452
|
-
must not rise, maintainability must not fall, tests must pass. If a test
|
|
453
|
-
needed editing, revert — behaviour changed.
|
|
454
|
-
|
|
455
|
-
Keep each refactor an isolated, reviewable commit separate from feature or fix
|
|
456
|
-
work, refactor only the targeted functions/duplications (no drive-by rewrites),
|
|
457
|
-
and leave no dead code behind (unused imports, orphaned helpers).
|
|
458
|
-
|
|
459
|
-
## Verification
|
|
460
|
-
|
|
461
|
-
After review is complete:
|
|
462
|
-
|
|
463
|
-
- [ ] All Critical issues are resolved
|
|
464
|
-
- [ ] All Important issues are resolved or explicitly deferred with
|
|
465
|
-
justification
|
|
466
|
-
- [ ] Tests pass
|
|
467
|
-
- [ ] Build succeeds
|
|
468
|
-
- [ ] The verification story is documented (what changed, how it was verified)
|
|
469
|
-
|
|
470
|
-
After a post-green refactor pass:
|
|
471
|
-
|
|
472
|
-
- [ ] The suite was green before and after, with **no test modifications**
|
|
473
|
-
- [ ] CRAP did not rise and maintainability did not fall on any touched file
|
|
474
|
-
(baselines re-run and compared)
|
|
475
|
-
- [ ] No gate, floor, or coverage threshold was loosened
|
|
476
|
-
- [ ] Duplication was removed at the root (one helper), not just locally patched
|
|
477
|
-
- [ ] Each refactor is an isolated commit, separate from feature or fix work
|
|
28
|
+
## Long-form reference — read on demand
|
|
29
|
+
|
|
30
|
+
The capsule above is the contract and the whole always-read surface of this
|
|
31
|
+
skill. The long-form material behind it — patterns, worked examples,
|
|
32
|
+
checklists, and rationalizations — lives in the on-demand sibling
|
|
33
|
+
[`reference.md`](reference.md), matching the split the always-on rules already
|
|
34
|
+
use ([`rules/git-conventions.md`](../../../rules/git-conventions.md) ⇄
|
|
35
|
+
[`git-conventions-reference.md`](../../../rules/git-conventions-reference.md)).
|
|
36
|
+
Activating this skill costs the capsule; open a section below only when the
|
|
37
|
+
task actually engages it.
|
|
38
|
+
|
|
39
|
+
- [Overview](reference.md#overview)
|
|
40
|
+
- [When to Use](reference.md#when-to-use)
|
|
41
|
+
- [The Five-Axis Review](reference.md#the-five-axis-review)
|
|
42
|
+
- [Change Sizing](reference.md#change-sizing)
|
|
43
|
+
- [Change Descriptions](reference.md#change-descriptions)
|
|
44
|
+
- [Review Process](reference.md#review-process)
|
|
45
|
+
- [Multi-Model Review Pattern](reference.md#multi-model-review-pattern)
|
|
46
|
+
- [Dead Code Hygiene](reference.md#dead-code-hygiene)
|
|
47
|
+
- [Review Speed](reference.md#review-speed)
|
|
48
|
+
- [Handling Disagreements](reference.md#handling-disagreements)
|
|
49
|
+
- [Honesty in Review](reference.md#honesty-in-review)
|
|
50
|
+
- [Dependency Discipline](reference.md#dependency-discipline)
|
|
51
|
+
- [The Review Checklist](reference.md#the-review-checklist)
|
|
52
|
+
- [Common Rationalizations](reference.md#common-rationalizations)
|
|
53
|
+
- [Red Flags](reference.md#red-flags)
|
|
54
|
+
- [Post-Green Refactor Pass](reference.md#post-green-refactor-pass)
|
|
55
|
+
- [Verification](reference.md#verification)
|