René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Bumping rule is wrongly documented","articleBody":"### Type\r\n\r\n- Content inaccurate\r\n\r\n### URL\r\n\r\nhttps://commitizen-tools.github.io/commitizen/bump/\r\n\r\n### Description\r\n\r\n## Problem\r\n\r\nThe docs state \"`fix`+everything else\" bumps `PATCH` of the version string per the default `commit_map`.\r\n\r\n![image](https://user-images.githubusercontent.com/59346180/169664342-1fa58936-67f1-4564-a590-53198736563d.png)\r\n\r\nHowever, this is not the case:\r\n\r\nhttps://github.com/commitizen-tools/commitizen/blob/79165119817cbd0aef25434a85dcbffa3a13acbb/commitizen/defaults.py#L78-L80\r\n\r\nOnly `fix`, `refactor`, and `perf` bump `PATCH`, leaving out `docs`, `style`, `test`, `build`, and `ci`, which don't bump any part of the version.\r\n\r\nNot only are the docs incorrect, but this is out of step with [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/#summary). Additional commit types are permitted by the specification (e.g. `commitizen` appears to be using the [Angular Convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) by default), but no guidance on version bumping is given for these addition types. Where a commit type bumps or does not bump a version, this should be explicitly stated (e.g. the commit message instructions for `fix` has `Correlates with PATCH in SemVer`, but not `refactor` or `perf`, leaving one to believe these do nothing). \r\n\r\n## Recommendations:\r\n\r\n1. **(PREFERRED; Conventional Commit spec)**: Only `feature` and `fix` should be in the default `commit_map` per [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/#summary). `refactor` and `perf` should not bump `PATCH`. The Angular types `refactor`, `perf`, `docs`, `style`, `test`, `build`, and `ci` should be removed from the default commit types.\r\n\r\n1. **(ALTERNATIVE; Angular Convention, but with explicit messaging)**: `refactor` and `perf` should not bump `PATCH`. The commit message instructions for `refactor`, `perf`, `docs`, `style`, `test`, `build`, and `ci` should add `Correlates with no version bump in SemVer`. In addition, the docs should clearly state the  [Angular Convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) commit types are included in `cz c` by default.\r\n\r\n## Tasks:\r\n\r\n- [ ] Correct the documentation (state what change types bump versions and that commitizen includes Angular Convention types by default)  \r\n- [ ] Add notes in commit message instructions to identify what version bump occurs with all change types (e.g. Correlates with no version bump in SemVer)  ","author":{"url":"https://github.com/adam-grant-hendry","@type":"Person","name":"adam-grant-hendry"},"datePublished":"2022-05-21T18:54:13.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":14},"url":"https://github.com/515/commitizen/issues/515"}