Skip to content

Commit 4ed8d31

Browse files
BogayLee-W
authored andcommitted
docs: move all FAQs to docs/faq.md
So now we have a single place to view all the FAQs.
1 parent 7d2c3c2 commit 4ed8d31

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

docs/README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -175,23 +175,11 @@ See [Third-Party Commitizen Templates](third-party-commitizen.md).
175175

176176
## FAQ
177177

178-
### Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select?
179-
180-
`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).
181-
However, you can create a customized `cz` with those extra types. (See [Customization](https://commitizen-tools.github.io/commitizen/customization))
182-
183-
See more discussion in issue [#142](https://github.com/commitizen-tools/commitizen/issues/142) and [#36](https://github.com/commitizen-tools/commitizen/issues/36)
184-
185-
### How to handle revert commits?
186-
187-
```sh
188-
git revert --no-commit <SHA>
189-
git commit -m "revert: foo bar"
190-
```
178+
See [FAQ - commitizen](https://commitizen-tools.github.io/commitizen/faq/).
191179

192180
## Contributing
193181

194-
See [Contributing](contributing.md)
182+
See [Contributing](contributing.md).
195183

196184
[conventional_commits]: https://www.conventionalcommits.org
197185
[semver]: https://semver.org/

docs/faq.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,10 @@ If you are using conventional commits in your git history, then you could swap o
7373
Regarding the name, [cz-js][cz-js] came first, they used the word commitizen first. When this project was created originally, the creator read "be a good commitizen", and thought it was just a cool word that made sense, and this would be a package that helps you be a good "commit citizen".
7474

7575
[cz-js]: https://github.com/commitizen/cz-cli
76+
77+
### How to handle revert commits?
78+
79+
```sh
80+
git revert --no-commit <SHA>
81+
git commit -m "revert: foo bar"
82+
```

0 commit comments

Comments
 (0)