feat: move Requirements to companion file (requirements.md)#84
Merged
corvid-agent merged 5 commits intomainfrom Mar 31, 2026
Merged
feat: move Requirements to companion file (requirements.md)#84corvid-agent merged 5 commits intomainfrom
corvid-agent merged 5 commits intomainfrom
Conversation
Add a Requirements section (user stories + acceptance criteria) as the 8th default required section, positioned after Purpose and before Public API. This enables a natural product/AI workflow where humans define what a module should do from a user perspective, and AI fills in the technical details. - Add "Requirements" to default_required_sections() in types.rs - Add ## Requirements to all 6 built-in language templates in generator.rs - Update all 15 project spec files with the new section - Update docs, config, and all test fixtures - Bump version to 3.1.0 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Requirements to all default section lists, config examples, spec examples, and AGENTS.md. Add v3.1.0 CHANGELOG entry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add support for AGENTS.md as a hook target, following the OpenAI Codex convention. Works the same as the existing claude/cursor/copilot targets: creates or appends spec-sync instructions to AGENTS.md. CLI: specsync hooks install --agents Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Requirements as a required spec section (v3.1.0) blurred the authorship boundary between technical contracts and product asks. This moves requirements to a per-module companion file (requirements.md) alongside tasks.md and context.md, keeping specs focused as dev-authored technical contracts while giving Product/Design their own space. Changes: - Remove "Requirements" from default required sections - Remove ## Requirements from all spec templates (default + 5 languages) - Add requirements.md companion file template with User Stories, Acceptance Criteria, Constraints, and Out of Scope sections - Scaffold requirements.md alongside tasks.md and context.md - Update all 15 existing specs and add requirements.md for each module - Update docs, README, SCOPE, CLI docs, and integration tests Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ents sections Merge from main re-introduced ## Requirements as a required section (from v3.1.0). Removed it from all spec files, templates, validator defaults, test fixtures, and specsync.json to keep this branch's companion-file approach consistent. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
## Requirementsas a required spec section (added in v3.1.0) — requirements don't belong in the technical contractrequirements.mdas a per-module companion file scaffolded alongsidetasks.mdandcontext.mdCompanion file model
{module}.spec.mdtasks.mdcontext.mdrequirements.mdWhat changed
default_required_sections()and all 6 spec templatesREQUIREMENTS_TEMPLATEwith User Stories, Acceptance Criteria, Constraints, Out of Scopegenerate_companion_files()to scaffoldrequirements.md## Requirementsfrom all 15 existing specs, addedrequirements.mdfor eachTest plan
cargo build— compiles cleancargo test— 195 tests pass (119 unit + 76 integration)specsync check— all 15 specs pass, 100% coverageadd-spec/generatewill includerequirements.mdspecsync generateon a fresh project scaffolds all three companion files🤖 Generated with Claude Code