Skip to content

Commit 239d2c0

Browse files
committed
docs(readme.md): update documentation for types config
Remove example from default values section, and add a separate example with description.
1 parent 06c64c4 commit 239d2c0

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,32 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
2626
"defaultSubject": "",
2727
"defaultBody": "",
2828
"defaultIssues": "",
29-
"types": {
30-
...
31-
"feat": {
32-
"description": "A new feature",
33-
"title": "Features"
34-
},
35-
...
36-
},
29+
"types": null,
3730
"additionalTypes": {}
3831
}
3932
}
4033
// ...
4134
}
4235
```
4336

44-
The `additionalTypes` property can be used to add custom types in addition to those defined by **conventional-commit-types**:
37+
The `types` property can be used to *replace* the types defined by **conventional-commit-types**:
38+
39+
```json5
40+
"config": {
41+
"commitizen": {
42+
"types": {
43+
...
44+
"feat": {
45+
"description": "A new feature",
46+
"title": "Features"
47+
},
48+
...
49+
}
50+
}
51+
}
52+
```
53+
54+
The `additionalTypes` property can be used to add custom types in *addition to* those defined by **conventional-commit-types**:
4555

4656
```json5
4757
"config": {

0 commit comments

Comments
 (0)