From 96db5b9ba76acea3df094cd23fbbdf85da06aef2 Mon Sep 17 00:00:00 2001 From: Niklas Wenzel Date: Wed, 1 Apr 2026 23:11:07 +0200 Subject: [PATCH 1/2] docs: sync release notes guide with e/e PR template --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6e3ebcb..2ec54cf 100644 --- a/README.md +++ b/README.md @@ -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: notes ``` * 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 From d3ea30248535b0b015a6e372a40c68ddfe56a853 Mon Sep 17 00:00:00 2001 From: Niklas Wenzel Date: Wed, 1 Apr 2026 23:12:31 +0200 Subject: [PATCH 2/2] fix: `none` example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ec54cf..2cf6b99 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ adding a single line to its description beginning with `Notes: `. * Omit notes for changes that users won't care about. ```diff - Notes: only define WIN32_LEAN_AND_MEAN if not already defined - + Notes: notes + + Notes: none ``` * For consistency in notes, use the past tense and capitalize and punctuate your notes.