Skip to content

Commit

Permalink
docs(readme.md): update documentation for types config
Browse files Browse the repository at this point in the history
Remove example from default values section, and add a separate
example with description.
  • Loading branch information
adrianschmidt committed May 5, 2020
1 parent 06c64c4 commit 239d2c0
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Expand Up @@ -26,22 +26,32 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
"defaultSubject": "",
"defaultBody": "",
"defaultIssues": "",
"types": {
...
"feat": {
"description": "A new feature",
"title": "Features"
},
...
},
"types": null,
"additionalTypes": {}
}
}
// ...
}
```

The `additionalTypes` property can be used to add custom types in addition to those defined by **conventional-commit-types**:
The `types` property can be used to *replace* the types defined by **conventional-commit-types**:

```json5
"config": {
"commitizen": {
"types": {
...
"feat": {
"description": "A new feature",
"title": "Features"
},
...
}
}
}
```

The `additionalTypes` property can be used to add custom types in *addition to* those defined by **conventional-commit-types**:

```json5
"config": {
Expand Down

0 comments on commit 239d2c0

Please sign in to comment.