|
2 | 2 |
|
3 | 3 | Copy and fill in for the GitHub release description (e.g. write into the temp file used with `gh release create --notes-file`). Adjust heading levels (`##` vs `###`) to match recent GA style (v2.0.0 used `###` subsections) or smaller patch style (v1.9.x used `##`). |
4 | 4 |
|
| 5 | +**Do not include a section if there is nothing to say** — omit the heading entirely (do not add “Breaking changes” with “None”, empty “Fixes”, etc.). Typical releases only need a subset of the sections below. |
| 6 | + |
5 | 7 | ## Summary |
6 | 8 |
|
7 | 9 | <!-- 2–4 sentences: who benefits, scope since previous tag (e.g. since `v1.9.1`). --> |
8 | 10 |
|
9 | 11 | ## Breaking changes / migration |
10 | 12 |
|
11 | | -<!-- Omit or state "None" for patch releases if accurate. For each item: what changed, why, what users must update (scripts, flags, CI). --> |
| 13 | +<!-- Include only when users must change scripts, configs, or habits. For each item: what changed, why, what to update (scripts, flags, CI). Omit this whole section when there are no breaking changes. --> |
12 | 14 |
|
13 | 15 | ## New features |
14 | 16 |
|
15 | | -<!-- Group by area/command. User-facing language; mention important flags. --> |
| 17 | +<!-- Include when shipping user-visible capability. Group by area/command; mention important flags. Omit if nothing applies. --> |
16 | 18 |
|
17 | 19 | ## Fixes |
18 | 20 |
|
19 | | -<!-- Optional: merge into "Improvements" for tiny releases. --> |
| 21 | +<!-- Omit if no fixes, or merge into Improvements for tiny releases. --> |
20 | 22 |
|
21 | 23 | ## Improvements / behavior changes |
22 | 24 |
|
23 | | -<!-- UX, defaults, performance, reliability visible to users. --> |
| 25 | +<!-- UX, defaults, performance, reliability visible to users. Omit if nothing applies. --> |
24 | 26 |
|
25 | 27 | ## Internal / reliability / infrastructure |
26 | 28 |
|
27 | | -<!-- Optional: refactors, test/CI, dependency bumps with low user-visible impact. --> |
| 29 | +<!-- Refactors, test/CI, dependency bumps with low user-visible impact. Omit if nothing worth mentioning. --> |
28 | 30 |
|
29 | 31 | ## Contributors (optional) |
30 | 32 |
|
|
0 commit comments