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

Open Beginner friendly
#1,908 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown, yaml
Domain
documentation

Research direction

Start with schemas/spec-driven/templates/proposal.md and the proposal instruction in schemas/spec-driven/schema.yaml. Add the matching short Review Focus guidance in both locations, then verify that the template and instruction stay concise and consistent without changing artifacts, validation, or workflows.

Written by the indexing model from the issue text.

Description

design-review

Problem

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.

Proposal

Add a short section near the top of schemas/spec-driven/templates/proposal.md, right after ## Why:

## 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

Add a matching line to the proposal instruction in schemas/spec-driven/schema.yaml: keep it short, and only list things a reviewer would actually want to check.

Why it fits

It's a template and guidance change only. Artifacts, validation and workflows don't change. Reviewers get a two-minute starting point, so review takes less time and the artifacts keep all their content.

Dominant language
TypeScript
Stars
69.6k
Forks
4.8k
Avg merge
4d 21h
Merged PRs (30d)
71

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Fission-AI/OpenSpec

All issues in Fission-AI/OpenSpec

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.