-
Notifications
You must be signed in to change notification settings - Fork 1.3k
fix: clarify spec naming convention and task checkbox format #595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Update docs, schema, and templates to clarify that specs should be named after capabilities (specs/<capability>/spec.md), not changes - Emphasize that tasks MUST use checkbox format for apply phase tracking
📝 WalkthroughWalkthroughDocumentation and templates were updated to specify per-capability spec placement using Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Review CompleteYour review story is ready! Comment !reviewfast on this PR to re-generate the story. |
Greptile OverviewGreptile SummaryThis PR improves documentation clarity for the spec-driven workflow by addressing two key areas:
The changes are consistent across documentation ( Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant Agent
participant Proposal
participant Schema
participant Specs
participant Tasks
User->>Agent: Request change via /openspec
Agent->>Schema: Read schema.yaml instructions
Schema-->>Agent: "Create spec per capability (specs/<capability>/spec.md)"
Agent->>Proposal: Create proposal.md
Note over Proposal: Capabilities section lists:<br/>- user-auth<br/>- data-export
Agent->>Schema: Read specs artifact instruction
Schema-->>Agent: "Use exact kebab-case name from proposal"
Agent->>Specs: Create specs/user-auth/spec.md
Agent->>Specs: Create specs/data-export/spec.md
Note over Specs: Named after CAPABILITIES,<br/>not the change name
Agent->>Schema: Read tasks artifact instruction
Schema-->>Agent: "Tasks MUST use checkbox format (- [ ])"
Agent->>Tasks: Create tasks.md with checkboxes
Note over Tasks: ## 1. Setup<br/>- [ ] 1.1 Task one<br/>- [ ] 1.2 Task two
User->>Agent: Run apply phase
Agent->>Tasks: Parse checkbox format
Tasks-->>Agent: Track progress via checkboxes
Agent->>Tasks: Mark completed: [x]
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@schemas/spec-driven/schema.yaml`:
- Around line 37-39: The line "Modified capabilities: use the existing spec
folder name in openspec/specs/<capability>/." is ambiguous about where the delta
spec should live; update the sentence to explicitly state that you should
reference the existing capability folder name but place the delta spec file for
the change under the change's directory at specs/<capability>/spec.md (i.e., do
not write into openspec/specs/<capability>/, only reference its folder name).
Modify the text near "Create one spec file per capability listed in the
proposal's Capabilities section." to include this clarification and an explicit
example showing the delta spec path (specs/<capability>/spec.md) while still
noting the canonical existing folder name in openspec for reference.
Address review feedback: explicitly state that the delta spec is created at specs/<capability>/spec.md, not in openspec/specs/<capability>/.
Summary
specs/<capability>/spec.md), not changes- [ ]) for apply phase trackingTest plan
🤖 Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.