f5a10419de
Drops a cheat sheet (CONTRIBUTING.md) in repo root so anyone — you, future maintainers — has the full commit-prefix table one glance away. Covers which prefixes trigger a release and which don't. Also adds .gitmessage that you can optionally wire into git as the default commit template: git config --local commit.template .gitmessage Opens the cheat sheet in your editor every time you `git commit` without -m. Remove it with `git config --local --unset commit.template`. This commit uses `docs:` prefix so it does NOT trigger a release — proving the auto-version workflow's filter works.
22 lines
809 B
Text
22 lines
809 B
Text
# <type>: <short summary>
|
|
#
|
|
# Types that cut a release:
|
|
# fix: → patch (6.1.1 → 6.1.2) bug fix
|
|
# feat: → minor (6.1.1 → 6.2.0) new feature
|
|
# feat!: → major (6.1.1 → 7.0.0) breaking change
|
|
#
|
|
# Types that commit but don't release:
|
|
# docs: documentation
|
|
# refactor: code reshape, no behavior change
|
|
# chore: tooling, deps, housekeeping
|
|
# test: tests only
|
|
# style: formatting / whitespace
|
|
# ci: CI/CD configuration
|
|
# build: build system / external deps
|
|
#
|
|
# Full reference: https://www.conventionalcommits.org/
|
|
# Or see CONTRIBUTING.md in this repo.
|
|
#
|
|
# ---- body below (optional) -------------------------------------------
|
|
# Explain the WHY more than the what. Breaking changes must include a
|
|
# line starting with "BREAKING CHANGE: <description>".
|