You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 6e7b54a
Browse filesBrowse the repository at this point in the historyBrowse files
docs(conventional_commits): clarify version bump per commit type
Closes#515
* Update the cz commit prompt to state the version bump impact for every
Conventional Commit type (refactor/perf correlate with PATCH; docs,
style, test, build and ci do not bump unless they include a
BREAKING CHANGE), matching the existing notes for fix and feat.
* Update conventional_commits_info.txt to call out commitizen's defaults
on top of the Conventional Commits specification.
* Add a "Recommended Reading on Versioning" section in
docs/external_links.md with the articles surfaced in the issue
discussion (Hynek, Brett Cannon, Donald Stufft, Hyrum's Law, 0ver,
CalVer) and cross-link it from docs/commands/bump.md.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/commands/bump.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,11 @@ The version follows the `MAJOR.MINOR.PATCH` format, with increments determined b
30
30
|`MINOR`| New features |`feat`|
31
31
|`PATCH`| Fixes and improvements |`fix`, `perf`, `refactor`|
32
32
33
+
Other Conventional Commit types recognized by Commitizen (such as `docs`, `style`, `test`, `build`, `ci`, and `chore`) do not bump the version unless they include a `BREAKING CHANGE`. You can customize this behavior with the [`bump_map`](../config/bump.md) and [`bump_pattern`](../config/bump.md) settings.
34
+
35
+
!!! tip "Recommended reading on versioning"
36
+
For background on the strengths and limitations of semantic versioning, and on alternative versioning strategies, see the [Recommended Reading on Versioning](../external_links.md#recommended-reading-on-versioning).
0 commit comments