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.

  - 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.

  - 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.

  - 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

  Notes:
  * Line 1
  * Line 2
  

Your release bot overlords thank you.