mirror of
https://github.com/scratchfoundation/scratch-svg-renderer.git
synced 2024-11-14 19:25:41 -05:00
chore: add commitizen config
This commit is contained in:
parent
a4f2e3c699
commit
c503e1d70f
2 changed files with 22 additions and 0 deletions
17
README.md
17
README.md
|
@ -60,3 +60,20 @@ To run scratch-svg-renderer locally as part of scratch-gui, for development:
|
|||
|
||||
## Donate
|
||||
We provide [Scratch](https://scratch.mit.edu) free of charge, and want to keep it that way! Please consider making a [donation](https://secure.donationpay.org/scratchfoundation/) to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!
|
||||
|
||||
## 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`.
|
||||
|
|
|
@ -55,5 +55,10 @@
|
|||
"webpack-cli": "3.3.12",
|
||||
"webpack-dev-server": "3.11.2",
|
||||
"xmldom": "0.1.31"
|
||||
},
|
||||
"config": {
|
||||
"commitizen": {
|
||||
"path": "cz-conventional-changelog"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue