Skip to content

Commit 87281ff

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 5a764bf commit 87281ff

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
@@ -189,23 +189,11 @@ See [Third-Party Commitizen Templates](third-party-commitizen.md).
189189

190190
## FAQ
191191

192-
### Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select?
193-
194-
`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).
195-
However, you can create a customized `cz` with those extra types. (See [Customization](https://commitizen-tools.github.io/commitizen/customization))
196-
197-
See more discussion in issue [#142](https://github.com/commitizen-tools/commitizen/issues/142) and [#36](https://github.com/commitizen-tools/commitizen/issues/36)
198-
199-
### How to handle revert commits?
200-
201-
```sh
202-
git revert --no-commit <SHA>
203-
git commit -m "revert: foo bar"
204-
```
192+
See [FAQ - commitizen](https://commitizen-tools.github.io/commitizen/faq/).
205193

206194
## Contributing
207195

208-
See [Contributing](contributing.md)
196+
See [Contributing](contributing.md).
209197

210198
[conventional_commits]: https://www.conventionalcommits.org
211199
[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)