Instruction file imported from leyaniv/apt-ranker-2183 (
.github/instructions/commit-messages.instructions.md). Copyright stays with the author.
Commit Messages
Commit messages describe what changed and why — nothing else.
Rules
- Do not mention version numbers (e.g.
v1.1.1,1.2.0,Release …) in commit titles or bodies. Versions belong in git tags and inCHANGELOG.md/package.jsononly. - Title: a single, concise, imperative sentence summarizing the change (e.g.
Simplify air-direction scoring and switch to fixed buckets). No prefixes likeRelease,Bump, orvX.Y.Z. - Body (optional): bullet list of notable changes, each describing user-visible or technical impact. Still no version strings.
- Tags carry the version. When releasing, bump
package.jsonand updateCHANGELOG.mdin the same commit, then create an annotated tagvX.Y.Zpointing at that commit.
Why
Versioning lives in tags so the commit log stays a clean narrative of changes, independent of release cadence. A commit may be re-tagged, cherry-picked, or never released — its message should still make sense.