Skip to content

docs(releases): use plain-language release titles and notes #101

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
Go2Engle merged 1 commit into from
Oct 10, 2026
Merged

docs(releases): use plain-language release titles and notes #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ Use human-readable Conventional Commit subjects and PR titles. Release Please ma
files and `CHANGELOG.md`; do not edit them by hand. Describe the actual user-visible result in
feature and fix subjects because those subjects become the public release notes.

Write release titles, release notes, and feature/fix subjects for people who are not developers.
Lead with what users can do or what improves for them, and use familiar language instead of
implementation terms. For example, prefer "make updates easier from inside CriProx" over
"add verified downloads and installer handoff". Keep Conventional Commit prefixes for automation,
but make the subject itself suitable for public release notes. Apply this preference when preparing
future commits, PR titles, and releases so the wording does not need to be rewritten afterward.

Website changes must never trigger an application release or appear in application release notes.
Use non-breaking `chore(site):`, `docs(site):`, or `style(site):` commits and PR titles for website
work, including screenshots and website workflows. Never use `feat(site):`, `fix(site):`, `perf(site):`,
Expand Down
Loading