Skip to content

feat(schemas): open each proposal with a short review focus - #1921

Open
GaoSSR wants to merge 3 commits into
Fission-AI:mainfrom
GaoSSR:feat/proposal-review-focus
Open

GaoSSR wants to merge 3 commits into
Fission-AI:mainfrom
GaoSSR:feat/proposal-review-focus

Conversation

@GaoSSR

@GaoSSR GaoSSR commented Sep 19, 2026

Copy link
Copy Markdown

Closes #1908.

What

Adds a ## Review Focus section to the spec-driven proposal template (schemas/spec-driven/templates/proposal.md), right after ## Why, plus a matching bullet in the proposal artifact instruction in schemas/spec-driven/schema.yaml:

## Review Focus

<!-- 3-5 bullets. Leave empty rather than pad. -->
- Decisions a human should confirm
- Assumptions made without asking
- What is deliberately out of scope

Why

A medium-sized change produces a proposal, design, delta specs and tasks. Reviewers don't know where to look first, so they either read everything or skim everything — and neither catches the places where the agent guessed. A short, mandatory-shaped section at the top of the proposal gives reviewers a two-minute starting point.

Template and guidance change only: artifacts, validation and workflows are unchanged. Empty sections cost nothing (the guidance says to leave it empty rather than pad).

Verification

  • pnpm build
  • pnpm test — 5745 passed ✅
  • pnpm exec tsc --noEmit
  • pnpm lint
  • Changeset included (patch)

Notes

Branch on my fork: GaoSSR/OpenSpec@feat/proposal-review-focus

Summary by CodeRabbit

  • New Features

    • Added a Review Focus section to proposal documents.
    • Prompts authors to highlight decisions for confirmation, assumptions made, and deliberately out-of-scope items.
    • Limits the section to 3–5 concise points and allows it to remain empty when not applicable.
  • Documentation

    • Updated proposal guidance to consistently include the new review-focused information.

Closes Fission-AI#1908.

A medium-sized change produces a proposal, design, delta specs and
tasks, and reviewers either read everything or skim everything -
neither catches the places where the agent guessed. A short Review
Focus section right after Why gives reviewers a two-minute starting
point: decisions a human should confirm, assumptions made without
asking, and what is deliberately out of scope.

Template and guidance change only; artifacts, validation and
workflows are unchanged.

Verified locally: pnpm build, pnpm test (5745 passed),
pnpm exec tsc --noEmit, pnpm lint.
Pairs with the new template section so generated proposals fill it in:
3-5 bullets listing only what a reviewer should actually check -
decisions a human should confirm, assumptions made without asking,
deliberate exclusions. Leave empty rather than pad.
@GaoSSR
GaoSSR requested a review from a team as a code owner September 19, 2026 05:01
@GaoSSR
GaoSSR requested review from clay-good and removed request for a team September 19, 2026 05:01
@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Fission-AI/OpenSpec/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: ba6e3eba-bbb5-4bce-ab1c-35d3269df998

📥 Commits

Reviewing files that changed from the base of the PR and between bae58cf and 220ea37.

📒 Files selected for processing (3)
  • .changeset/soft-walls-reply.md
  • schemas/spec-driven/schema.yaml
  • schemas/spec-driven/templates/proposal.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The proposal template now includes a Review Focus section. Schema instructions require 3–5 review-only bullets covering decisions, assumptions, and deliberate exclusions. A patch changeset records the update.

Changes

Proposal review guidance

Layer / File(s) Summary
Add Review Focus guidance
schemas/spec-driven/templates/proposal.md, schemas/spec-driven/schema.yaml, .changeset/soft-walls-reply.md
The proposal template adds a Review Focus section with three review categories. The schema instruction requires 3–5 bullets and allows an empty section. The changeset declares a patch release for @fission-ai/openspec.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 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 and concisely describes the main change: adding a short Review Focus section to proposal templates.
Linked Issues check ✅ Passed The pull request satisfies issue #1908. It adds ## Review Focus immediately after ## Why in schemas/spec-driven/templates/proposal.md. The section asks for 3-5 bullets about human-confirmed deci…
Out of Scope Changes check ✅ Passed The whole-pull-request diff contains only the requested template and schema guidance, plus a patch changeset that documents the feature. It does not change artifacts, validation, or workflows.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

feat(schemas): open each proposal with a short review focus

1 participant