docs: add agent-design convention pack (AD-001 through AD-010) - #28
Conversation
- Add .opencode/uf/packs/agent-design.md with 10 structural quality rules covering coupling, cohesion, complexity, naming, file size, duplication, contract coverage, and test assertion depth - Add agent-design-custom.md placeholder for project-level overrides - Add OpenSpec change artifacts (proposal, design, spec, tasks) - Update AGENTS.md convention packs list - Add CHANGELOG.md entry Closes #4 Assisted-by: claude-opus-4 Generated with AI assistance (claude-opus-4)
jflowers
left a comment
There was a problem hiding this comment.
Note: Could not post as APPROVE due to GitHub's self-review prohibition (PR author cannot approve their own PR). Posted as COMMENT instead. Original verdict: APPROVE.
Council Verdict: APPROVE
Reviewers: adversary, architect, curator, entropy, envoy, guard, herald, scribe, sre, testing
Iterations: 2 (initial review + 1 fix cycle)
Adversary (APPROVE)
4 LOW findings omitted.
Architect (APPROVE)
- [MEDIUM] Convention pack section headings deviate from established template (justified by D2 design decision — cross-cutting pack doesn't fit standard sections)
- [MEDIUM] Rule ID format differs from established convention (justified by D2 — richer format needed for threshold/enforcement mappings)
3 LOW findings omitted.
Curator (APPROVE)
- [MEDIUM] Convention pack lacks a summary table for quick agent scanning
- [HIGH] Missing documentation issue — resolved: filed as #29
2 LOW findings omitted.
Entropy (APPROVE)
4 LOW findings omitted.
Envoy (APPROVE — was REQUEST CHANGES)
All findings resolved in iteration 1:
- [MEDIUM] proposal.md AD-009 misclassification — fixed
3 LOW findings omitted.
Guard (APPROVE)
2 LOW findings omitted.
Herald (APPROVE)
5 LOW findings omitted.
Scribe (APPROVE — was REQUEST CHANGES)
All findings resolved in iteration 1:
- [HIGH] AD-003 leaf-exemption not enforced by CLI — fixed (enforcement clarification added)
2 LOW findings omitted.
SRE (APPROVE)
3 LOW findings omitted.
Testing (APPROVE)
6 LOW findings omitted.
Fixes Applied (Iteration 1)
proposal.md: Removed AD-009 from forward-planned listagent-design.md: Clarified AD-003 leaf exemption is agent-enforced, not CLI-enforcedspec.md: Fixed barevibe-check→vibe-check analyzefor AD-008tasks.md: Fixed 3 barevibe-checkinvocations to includeanalyzesubcommanddesign.md: Split forward-reference risk bullet; added leaf-package exemption documentation
This review was generated by /review-council (AI-assisted).
- Remove AD-009 from forward-planned list in proposal.md (--max-lcom exists) - Clarify AD-003 leaf exemption is agent-enforced, not CLI-enforced - Fix bare vibe-check invocations to include analyze subcommand - Split forward-reference risk bullet in design.md; add leaf-package exemption
PR Cost Report: #28Session: Change proposal workflowID:
Timeline: 2026-09-01 16:17:43 — 2026-09-01 17:37:18 Child sessions: 9 — additional cost: $6.93 Child session breakdown
Session: Code and spec review councilID:
Timeline: 2026-09-01 17:37:30 — 2026-09-02 08:34:51 Child sessions: 12 — additional cost: $9.13 Child session breakdown
Grand Total: $34.54 across 2 session tree(s) (23 sessions) |
Summary
Adds the agent-design convention pack (
.opencode/uf/packs/agent-design.md) with 10 structural quality rules (AD-001 through AD-010) that give AI coding agents explicit architectural constraints. This addresses issue #4.The pack covers:
Forward references to planned features (
--max-ce,--max-duplication) are explicitly marked with heuristic enforcement fallbacks.How to Test
Verify all 10 rules are present with required fields:
Verify vibe-check enforcement references (AD-002, AD-003, AD-004, AD-008, AD-009):
grep 'vibe-check' .opencode/uf/packs/agent-design.mdVerify gaze enforcement references (AD-001, AD-006, AD-010):
grep 'gaze' .opencode/uf/packs/agent-design.mdVerify AGENTS.md includes the new packs:
grep 'agent-design' AGENTS.mdVerify each rule has all required fields (Severity, Rationale, Threshold, Enforcement, Example with pass/fail):
How to Demo
.opencode/uf/packs/agent-design.mdand review the 10 rules organized by enforcement category.opencode/uf/packs/agent-design-custom.mdto see the project-level override placeholder withCR-NNNconventionAGENTS.mdConvention Packs section to confirm both files are listedKey Files Changed
Convention Pack (new)
.opencode/uf/packs/agent-design.md— Main pack with 10 structural quality rules (+236 lines).opencode/uf/packs/agent-design-custom.md— Override placeholder (+25 lines)Documentation (modified)
AGENTS.md— Added both pack files to Convention Packs list (+2 lines)CHANGELOG.md— Added unreleased entry for the new pack (+6 lines)OpenSpec Artifacts (new)
openspec/changes/agent-design-pack/proposal.md— Change proposal (+72 lines)openspec/changes/agent-design-pack/design.md— Design decisions (+111 lines)openspec/changes/agent-design-pack/specs/agent-design-rules/spec.md— 12 requirements with scenarios (+199 lines)openspec/changes/agent-design-pack/tasks.md— 16 tasks, all complete (+40 lines)Dewey Learnings (new)
.uf/dewey/learnings/— 4 session learnings (convention pack authoring, LCOM4 semantics, spec review patterns)Known Issues
The following findings from the review council were acknowledged but not resolved:
Spec:path to canonical spec. This is a project-wide gap (no existing CHANGELOG entries includeSpec:paths), not a regression.This PR was generated by /uf.finale (AI-assisted).