Skip to content

Commit 9fae319

Browse files
committed
fix(readme): update bullet labels and writing style for project purpose section
1 parent 9cd4489 commit 9fae319

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

.github/instructions/readme.instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ They are **non-negotiable** unless an explicit ADR grants a scoped, time-bound e
8989

9090
### 6.2 Why this project exists
9191

92-
- [RD-SEC-004] Populate the section using the exact bullet labels: **Purpose**, **Benefit to the reader**, **Problem it solves**, **How it solves it (high level)**.
93-
- [RD-SEC-005] Keep the section between four and eight lines, with each line grounded in repository evidence.
92+
- [RD-SEC-004] Populate the section using the exact subsections: **Purpose**, **Benefit to the user**, **Problem it solves**, **How it solves it (high level)**.
93+
- [RD-SEC-005] Use prose as the writing style in this section. Each of its subsections can have a sizable paragraph with good narrative being grounded in repository evidence.
9494

9595
### 6.3 Quick start
9696

.github/prompts/util.doc-readme-update.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The final `README.md` must contain sections in this exact order:
5858

5959
1. `# <Project Name>` `[RD-STR-002]`
6060
2. One-line summary immediately below the title `[RD-STR-003]`, `[RD-SEC-002]`
61-
3. `## Why this project exists` `[RD-STR-004]` — include bullets: **Purpose**, **Benefit to the reader**, **Problem it solves**, **How it solves it (high level)** `[RD-SEC-004]`
61+
3. `## Why this project exists` `[RD-STR-004]` — include the following subsections: **Purpose**, **Benefit to the user**, **Problem it solves**, **How it solves it (high level)** `[RD-SEC-004]`
6262
4. `## Quick start` `[RD-STR-005]` — prerequisites, install/setup, first run, expected output `[RD-SEC-007]``[RD-SEC-012]`
6363
5. `## What it does` `[RD-STR-006]` — 3–8 features, 2–6 non-goals, platforms if evidenced `[RD-SEC-013]``[RD-SEC-015]`
6464
6. `## How it solves the problem` `[RD-STR-007]` — short flow, key terms `[RD-SEC-016]``[RD-SEC-018]`

0 commit comments

Comments
 (0)