Skip to content

Commit 9726079

Browse files
committed
docs(FAQ): add revert and chore types discussion
1 parent ba860ac commit 9726079

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,23 @@ commands:
102102
init init commitizen configuration
103103
```
104104

105+
## FAQ
106+
107+
### Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select?
108+
109+
`revert` and `chore` are added to the "pattern" in `cz check` in order to prevent backward errors, but officially they are not part of conventional commits, we are using the latest [types from Angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) (they used to but were removed). Using `chore` or `revert` would be part of a different custom rule.
110+
111+
However, you can always create a customized `cz` with those extra types (See [Customization](https://commitizen-tools.github.io/commitizen/customization/).
112+
113+
See more discussion in issue [#142](https://github.com/commitizen-tools/commitizen/issues/142) and [#36](https://github.com/commitizen-tools/commitizen/issues/36)
114+
115+
### How to handle revert commits?
116+
117+
```sh
118+
git revert --no-commit <SHA>
119+
git commit -m "revert: foo bar"
120+
```
121+
105122
## Contributing
106123

107124
Feel free to create a PR.

0 commit comments

Comments
 (0)