https://github.com/electron/clerk
Verify PRs have release notes
https://github.com/electron/clerk
Last synced: about 2 months ago
JSON representation
Verify PRs have release notes
- Host: GitHub
- URL: https://github.com/electron/clerk
- Owner: electron
- License: mit
- Created: 2018-08-14T20:48:33.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T09:37:36.000Z (7 months ago)
- Last Synced: 2024-10-29T17:15:20.331Z (7 months ago)
- Language: TypeScript
- Size: 1010 KB
- Stars: 51
- Watchers: 7
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/electron/clerk/actions/workflows/test.yml)
# What is Clerk?
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: `.
# Examples
* **`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.
```
* 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
```
* 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.
```
* Multi-line release notes
```md
Notes:
* Line 1
* Line 2
```
**Your release bot overlords thank you.**