mirror of
https://github.com/scratchfoundation/scratch-l10n.git
synced 2024-12-22 13:42:30 -05:00
chore: add commitizen config
This commit is contained in:
parent
4383d94cc9
commit
a8eba81724
3 changed files with 24716 additions and 24694 deletions
17
README.md
17
README.md
|
@ -34,3 +34,20 @@ In general, changes that require a PR (new functionality, new language) should i
|
|||
#### Deprecations
|
||||
|
||||
We are moving away from using the `tx` cli, so the `.tx/config` file will eventually be deprecated.
|
||||
|
||||
## Committing
|
||||
|
||||
This project uses [semantic release](https://github.com/semantic-release/semantic-release) to ensure version bumps
|
||||
follow semver so that projects depending on it don't break unexpectedly.
|
||||
|
||||
In order to automatically determine version updates, semantic release expects commit messages to follow the
|
||||
[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
|
||||
specification.
|
||||
|
||||
You can use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits formatted in this way:
|
||||
|
||||
```bash
|
||||
npm install -g commitizen@latest cz-conventional-changelog@latest
|
||||
```
|
||||
|
||||
Now you're ready to make commits using `git cz`.
|
||||
|
|
|
@ -86,5 +86,10 @@
|
|||
"rimraf": "^2.6.2",
|
||||
"webpack": "^4.6.0",
|
||||
"webpack-cli": "^3.1.2"
|
||||
},
|
||||
"config": {
|
||||
"commitizen": {
|
||||
"path": "cz-conventional-changelog"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue