Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 65d001f

Browse files
authored
Merge pull request #343 from commitizen-tools/docs/update-faq
docs(faq): add new questions to faq
2 parents 8fabcff + bf3fce4 commit 65d001f

File tree

2 files changed

+56
-7
lines changed

2 files changed

+56
-7
lines changed

‎docs/external_links.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
> If you have written over commitizen, make a PR and add the link here 💪
2+
13
## Talks
24

3-
- commitizen-tools: What can we gain from crafting a git message convention
4-
- Speaker: Wei Lee
5-
- Occasion: Taipey.py 2020 June Meetup, Remote Python Pizza 2020
6-
- Material
7-
-[slides](https://speakerdeck.com/leew/commitizen-tools-what-can-we-gain-from-crafting-a-git-message-convention-at-taipey-dot-py)
5+
| Name | Speaker | Occasion | Language | Extra |
6+
| ------------------------------------------------------------------------- | --------------- | ---------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
7+
| commitizen-tools: What can we gain from crafting a git message convention | Wei Lee |Taipey.py 2020 June Meetup, Remote Python Pizza 2020| English |[slides](https://speakerdeck.com/leew/commitizen-tools-what-can-we-gain-from-crafting-a-git-message-convention-at-taipey-dot-py)|
8+
| Automating release cycles | Santiago Fraire | PyAmsterdam June 24, 2020, Online | English |[slides](https://woile.github.io/commitizen-presentation/)|
9+
|[Automatizando Releases con Commitizen y Github Actions][automatizando]| Santiago Fraire | PyConAr 2020, Remote | Español |[slides](https://woile.github.io/automating-releases-github-actions-presentation/#/)|
810

911
## Articles
1012

1113
- [Python Table Manners - Commitizen: 規格化 commit message](https://lee-w.github.io/posts/tech/2020/03/python-table-manners-commitizen/) (Written in Traditional Mandarin)
12-
- [Automating semantic release with commitizen](http://woile.github.io/posts/automating-semver-releases-with-commitizen/) (English)
14+
- [Automating semantic release with commitizen](https://woile.dev/posts/automating-semver-releases-with-commitizen/) (English)
1315

14-
> If you have written about commitizen, you can make a PR to add the link here 💪
16+
[automatizando]: https://youtu.be/t3aE2M8UPBo

‎docs/faq.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,50 @@ version_files = [
2626
"package.json:\"version\":"
2727
]
2828
```
29+
30+
### Why are `revert` and `chore` valid types in the check pattern of cz conventional_commits but not types we can select?
31+
32+
`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).
33+
However, you can create a customized `cz` with those extra types. (See [Customization](https://commitizen-tools.github.io/commitizen/customization/)
34+
35+
See more discussion in issue [#142](https://github.com/commitizen-tools/commitizen/issues/142) and [#36](https://github.com/commitizen-tools/commitizen/issues/36)
36+
37+
### How to revert a bump?
38+
39+
If for any reason, the created tag and changelog were to be undone, this is the snippet:
40+
41+
```sh
42+
git tag --delete <created_tag>
43+
git reset HEAD~
44+
git reset --hard HEAD
45+
```
46+
47+
This will remove the last tag created, plus the commit containing the update to `.cz.toml` and the changelog generated for the version.
48+
49+
In case the commit was pushed to the server you can remove it by running
50+
51+
```sh
52+
git push --delete origin <created_tag>
53+
```
54+
55+
## Is this project affiliated with the Commitizen JS project?
56+
57+
It is not affiliated.
58+
59+
Both are used for similar purposes, parsing commits, generating changelog and version we presume.
60+
This one is written in python to make integration easier for python projects and the other serves the JS packages.
61+
62+
They differ a bit in design, not sure if cz-js does any of this, but these are some of the stuff you can do with this repo (python's commitizen):
63+
64+
- create custom rules, version bumps and changelog generation, by default we use the popular conventional commits (I think cz-js allows this).
65+
- single package, install one thing and it will work (cz-js is a monorepo, but you have to install different dependencies AFAIK)
66+
- pre-commit integration
67+
- works on any language project, as long as you create the `.cz.toml` file.
68+
69+
Where do they cross paths?
70+
71+
If you are using conventional commits in your git history, then you could swap one with the other in theory.
72+
73+
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".
74+
75+
[cz-js]: https://github.com/commitizen/cz-cli

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /