conventional-release
Skill3 starsChanged 11 days agoApache-2.0View on GitHub
Ship changes through a squash-merge + Conventional Commits release pipeline where the PR title becomes the release note and the commit type drives the next semantic version. Use when writing a PR title or commit message that feeds an automated release, choosing the version bump for a change, setting up or reasoning about semantic-release / release-please / github-tag-action / Changesets, or avoiding a title that corrupts the changelog.
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- agent-improvementSkill
- agent-instructionsSkill
- allowed-stack-guardrailSkill
- gitops-tenant-onboardingSkill
- jargon-free-voiceSkill
- needs-stack-mappingSkill
- portfolio-maintenanceSkill
- product-documentationSkill
- product-engineeringSkill
- self-improvementSkill
- ways-of-workingSkill
- write-contributingSkill
- write-docs-introductionSkill
- write-readmeSkill
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 5 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 21
Use this skill whenever you open or merge a PR into a repository that releases this way, or when you need to decide which version a change …
- Distinctive: line 26
Look for any one of:
- Distinctive: line 39
If the repo squash-merges but releases manually, the title still matters for history and review — keep writing Conventional Commit titles, …
- Very specific: line 125
add a BREAKING CHANGE: footer for majors (see above).
- Distinctive: line 129
Keep wrap at ~72 columns; the first body line must be blank (separating it from the title).
- Very specific: line 141
Reverting a release: Use revert: (or the tool's revert convention) so the changelog records the rollback rather than a silent gap.
- Distinctive: line 153
If the repo lints commits/titles in CI, that check is green — fix the title, never bypass the lint.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Conventional Release
A widely-used release pattern: every PR is squash-merged, its title is a Conventional Commit, and an automated tool on the default branch reads the commit type to calculate the next SemVer tag, cut a release, and generate the changelog. No human writes a version number or a changelog entry by hand — the merge title is the release note, and the type is the bump.
Use this skill whenever you open or merge a PR into a repository that releases this way, or when you need to decide which version a change should produce.
How to tell a repo uses this pattern
Look for any one of:
- A release tool wired to run on push to the default branch:
semantic-release,release-please,mathieudutour/github-tag-action, or Changesets. - Branch protection that only allows squash merging (so the PR title is the sole commit message that reaches the default branch).
- A
CHANGELOG.mdthat is generated, or release notes grouped byFeatures/Bug Fixes. - A
commitlint/commitizenconfig, or CI that lints the PR title against the Conventional Commits spec.
If the repo squash-merges but releases manually, the title still matters for history and review — keep writing Conventional Commit titles, but the version step is the maintainer's.
The non-negotiable: the squash title is the only message that survives
With squash merging, GitHub collapses every commit on the branch into one commit on the default branch, and that commit's message defaults to the PR title. The release tool reads that message. So:
- The individual commits on your branch do not drive the release — only the final squash message does. Tidy WIP commits are fine; the PR title is what counts.
- The PR title MUST be a single valid Conventional Commit line. A title like
[fix] thingorWIP: thingorUpdate READMEeither yields no release, the wrong bump, or a corrupted changelog entry. - Never put a bracketed prefix, ticket id, or label in the title (
[infra],JIRA-123:,(wip)). Attribution belongs in labels and the branch name, never the title — a prefix before the type breaks the parser and pollutes the release notes.
Anatomy of the title
<type>(<optional scope>): <imperative summary><type>— one of the types below; it selects the version bump.(<scope>)— optional, a noun for the area touched:feat(api):,fix(parser):. Keep it short and consistent with the repo's existing scopes.<summary>— imperative mood (add, notadded/adds), lower-case start, no trailing period, kept under ~72 chars. Describe the change from the user's perspective, because it becomes their changelog line.
Type → version bump
The default mapping (Angular/Conventional Commits preset, used by all four tools above):
| Type | Meaning | Bump |
feat | a new user-facing capability | minor (x.Y.0) |
fix | a bug fix | patch (x.y.Z) |
perf | a performance improvement | patch (often) |
docs | documentation only | none by default |
refactor | behaviour-preserving code change | none by default |
test | adding or fixing tests | none by default |
build / ci | build system or pipeline | none by default |
chore | maintenance, deps, tooling | none by default |
style | formatting only | none by default |
revert | revert a prior change | patch (often) |
A push that contains only no-bump types yields no release — a deliberate, green "nothing to
ship" outcome, not a failure. Do not invent a feat: to force a tag.
Breaking changes → major
A breaking change is a major bump (X.0.0), signalled either way:
- a
!after the type/scope:feat(api)!: drop the v1 endpoint, or a
BREAKING CHANGE:footer in the body:feat(api): replace the auth header BREAKING CHANGE: clients must send `Authorization: Bearer` instead of `X-Token`.
Pre-1.0 (0.y.z) repos may map breaking changes to a minor bump instead — check the repo's release
config (semantic-release and release-please honour SemVer's 0.x rules). When unsure, state the
breaking nature explicitly and let the tool decide the number.
Choosing the bump deliberately
Pick the type from the effect on the consumer, not the size of the diff:
- A one-line change that alters output a user depends on is a
fix(or a breakingfeat!), not achore. - A 500-line internal refactor that changes no behaviour is
refactor— none — even though it is large. - Bumping a dependency that changes runtime behaviour the user sees is a
fix/feat; a dev-only or pinned-tooling bump ischore. - Splitting unrelated changes across PRs lets each get its correct type and its own release note — prefer that over one mixed PR with a vague title.
Writing the body
The body is optional for simple changes and flows into the release notes under the title. Use it to:
- explain why, not just what (reviewers and the changelog reader both benefit);
- add a
BREAKING CHANGE:footer for majors (see above); - reference issues with
Fixes #123/Closes #123so the merge closes them; - credit co-authors with
Co-authored-by:trailers.
Keep wrap at ~72 columns; the first body line must be blank (separating it from the title).
Pitfalls
- Title fixed after approval but before merge. Reviewers may approve a draft title; always re-read the final title at merge time — it is what ships. Many UIs pre-fill the squash message from the first commit, not the PR title; confirm the squash message equals the intended title before confirming the merge.
- Multiple logical changes, one PR. The single title can only carry one type. Either split the PR or pick the highest-impact type and enumerate the rest in the body.
- No-bump type when you meant to release.
chore: add retry to the clientships nothing; if users get the retry, it is afix/feat. - Reverting a release. Use
revert:(or the tool's revert convention) so the changelog records the rollback rather than a silent gap. - Scope sprawl. Inconsistent scopes (
api,API,apis) fragment the changelog; reuse the scopes already present in the history.
Verify before merging
- The PR title parses as
<type>(<scope>)?: <summary>with a real type — no bracket/prefix, no trailing period, imperative mood. - The chosen type produces the intended bump (or an intended no release).
- Any breaking change carries
!or aBREAKING CHANGE:footer. - The squash-merge message the platform will use equals that title (re-check at the merge dialog).
- If the repo lints commits/titles in CI, that check is green — fix the title, never bypass the lint.
Related skills
git-commit— compose a Conventional Commit message from a working-tree diff (the local-author side of the same convention).ways-of-working— the broader issue → plan → implement → test → review flow these releases sit in.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

