feat(schema): add one-sentence-per-line convention for artifact prose#1269
feat(schema): add one-sentence-per-line convention for artifact prose#1269Lingxi-Li wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe schema adds a prose formatting rule to four workflow phase instruction blocks ( ChangesProse Formatting Rule
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Summary
Adds a one-sentence-per-line authoring convention to the bundled spec-driven schema, telling agents to put each sentence of artifact prose on its own line.
Why
OpenSpec artifacts are version controlled, so they should diff cleanly.
A paragraph kept on one line marks the whole paragraph as changed for any edit, so the diff can't pinpoint which sentence was touched.
One sentence per line confines each edit to a single line, keeping reviews and blame precise.
What changed
Appends the convention to the four prose-bearing artifacts in
schemas/spec-driven/schema.yaml: proposal, specs, design, and tasks.The apply phase is excluded because it executes tasks rather than authoring prose.
The convention affects prose paragraphs only.
Testing
Ran the schema and instruction-loader suites; all passed.
Summary by CodeRabbit