Skip to content

docs: sync release notes guide with e/e PR template #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikwen merged 2 commits into from
Apr 1, 2026
+11 −11
Merged

docs: sync release notes guide with e/e PR template #190

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96db5b9
docs: sync release notes guide with e/e PR template
nikwen Apr 1, 2026
d3ea302
fix: `none` example
nikwen Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,30 @@

Clerk ensures that release notes can be generated from PRs by looking for
a release note in the PR description. You can add a note to your PR by
adding a single line to its description beginning with `notes: `.
adding a single line to its description beginning with `Notes: `.

# Examples

* **`commit -m` is for maintainers. `notes:` is for users.**
* **`commit -m` is for maintainers. `Notes:` is for users.**
Describe the change in user terms.
```diff
- notes: Bump libcc to latest.
- notes: Backport patch to fix Widget::OnSizeConstraintsChanged crash (3.0.x)
+ notes: Fixed crash in Widget::OnSizeConstraintsChanged.
- Notes: Bump libcc to latest.
- Notes: Backport patch to fix Widget::OnSizeConstraintsChanged crash (3.0.x)
+ Notes: Fixed crash in Widget::OnSizeConstraintsChanged.
```

* Omit notes for changes that users won't care about.
```diff
- notes: only define WIN32_LEAN_AND_MEAN if not already defined
+ notes: no-notes
- Notes: only define WIN32_LEAN_AND_MEAN if not already defined
+ Notes: none
```

* For consistency in notes, use the past tense and capitalize and punctuate your notes.
```diff
- notes: fix ipcRemote.sendSync regression introduced in a previous 3.0.0 beta
+ notes: Fixed ipcRemote.sendSync regression introduced in a previous 3.0.0 beta.
- notes: remove upstream code that used private Mac APIs
+ notes: Removed upstream code that used private Mac APIs.
- Notes: fix ipcRemote.sendSync regression introduced in a previous 3.0.0 beta
+ Notes: Fixed ipcRemote.sendSync regression introduced in a previous 3.0.0 beta.
- Notes: remove upstream code that used private Mac APIs
+ Notes: Removed upstream code that used private Mac APIs.
```

* Multi-line release notes
Expand Down