Plainwork

Plainwork / Release Notes Kit / Free release notes checker and template

Free release notes checker and template

Paste the notes for one release and get a list of the lines that read like commit messages, carry bare issue numbers or bare links, still contain a TODO, or use developer words where customers will read them. Or make a release-notes file with a section for each reader. It runs in your browser: nothing is uploaded.

1. Check your notes



2. Start a release file


Sections to include

The checks are the same word lists the kit uses (the node build.mjs check command). They are simple patterns, not understanding: they miss things and sometimes flag a sentence that is fine. The file format is the kit's: front matter, ## Users style sections, ### Added style groups. See what the kit builds from files like this.

What the checker looks for

  • Lines that start like a commit message (fix:, feat:, chore(deps):).
  • Bare issue or pull request numbers such as #412 with no link and no explanation.
  • Web addresses pasted without link text, and links broken by a space between the brackets.
  • TODO, WIP and FIXME left in the text.
  • For customer-facing notes: words like refactor, dependency, endpoint, payload, pull request, migration and CI.
  • Items shorter than 8 or longer than 400 characters.

More from the catalogue

Other small tools

See everything →