|
1 | 1 | <!-- |
2 | | -Title: use `<type>: <description>`, with a Conventional Commit type and a |
3 | | -concise lowercase imperative description, without terminal punctuation. |
4 | | -Example: `feat: add state replicator crate` |
| 2 | +Title: `<type>: <description>`, with a Conventional Commit type and a |
| 3 | +concise lowercase description, without terminal punctuation. |
| 4 | +Example: `refactor: simpler error handling` |
5 | 5 | --> |
6 | 6 |
|
7 | 7 | ## What changed |
8 | | -<!-- Summarize the change at the immediate-parent diff boundary. --> |
| 8 | +<!-- What changed relative to the immediate parent, and why. Explanatory prose, not instructions. --> |
9 | 9 |
|
10 | | -<!-- Replace ISSUE with the dedicated issue number. --> |
| 10 | +<!-- Dedicated issue completed by this PR, when applicable. --> |
11 | 11 | Closes #ISSUE |
12 | 12 |
|
13 | 13 | <!-- |
14 | | -Impact and Reviewer notes are optional. Include only relevant, non-obvious |
15 | | -information; do not narrate the code. Omit either section when it adds no value, |
16 | | -including for routine chores such as dependency updates or typo fixes. |
| 14 | +Impact and Reviewer notes are optional: relevant, non-obvious information only, |
| 15 | +without a code inventory. Routine chores may need neither section. |
17 | 16 | --> |
18 | 17 |
|
19 | 18 | ## Impact |
20 | | -<!-- Note behavior, API, storage, compatibility, security, or performance effects. --> |
| 19 | +<!-- Behavior, API, storage, compatibility, security, or performance effects. --> |
21 | 20 |
|
22 | 21 | ## Reviewer notes |
23 | | -<!-- Point reviewers to invariants, sharp edges, or the highest-risk part of the diff. --> |
| 22 | +<!-- Invariants, sharp edges, or the highest-risk part of the diff. --> |
0 commit comments