Skip to content

feat(schema): add one-sentence-per-line convention for artifact prose#1269

Open
Lingxi-Li wants to merge 1 commit into
Fission-AI:mainfrom
Lingxi-Li:clean-diff
Open

feat(schema): add one-sentence-per-line convention for artifact prose#1269
Lingxi-Li wants to merge 1 commit into
Fission-AI:mainfrom
Lingxi-Li:clean-diff

Conversation

@Lingxi-Li

@Lingxi-Li Lingxi-Li commented Jun 27, 2026

Copy link
Copy Markdown

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

  • Documentation
    • Updated writing instructions across multiple workflow phases to enforce consistent prose formatting.
    • Guidance now requires one sentence per line and prevents sentence wrapping onto multiple lines.
    • This helps keep diffs clean and review changes more easily.

@Lingxi-Li Lingxi-Li requested a review from TabishB as a code owner June 27, 2026 15:43
@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d230b4ce-7875-4f27-9a83-fc5e5f8b8e40

📥 Commits

Reviewing files that changed from the base of the PR and between 0c49565 and 7a81f22.

📒 Files selected for processing (1)
  • schemas/spec-driven/schema.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
  • schemas/spec-driven/schema.yaml

📝 Walkthrough

Walkthrough

The schema adds a prose formatting rule to four workflow phase instruction blocks (proposal, specs, design, tasks): each sentence in a prose paragraph must appear on its own line and must not wrap across multiple lines.

Changes

Prose Formatting Rule

Layer / File(s) Summary
One-sentence-per-line instruction across all phases
schemas/spec-driven/schema.yaml
Adds identical prose formatting requirement to the instruction blocks of the proposal, specs, design, and tasks phases.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A sentence stands alone, it's true,
No wrapping lines to muddle through.
Each thought gets its own tidy row,
So diffs stay clean, reviewers know.
One line, one thought — the rabbit's way! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the schema update adding a one-sentence-per-line prose convention.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant