Skip to content

Commit 1ce1b8d

Browse files
committed
Update release docs with better changelog guidance
1 parent 14088f2 commit 1ce1b8d

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

AGENTS/release.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ Suggested guidance to give users:
2525
```
2626
gh release edit v0.1.0 --notes "## What's New
2727
28-
- **Feature name** - Brief description of the change."
28+
- **Feature name** - Brief description of the change, explaining what was wrong and how it's fixed."
2929
```
30+
Use past tense for fixes ("Fixed X") and describe both the problem and solution.
3031

3132
## Required GitHub secrets (release signing)
3233

0 commit comments

Comments
 (0)