Skip to content

Commit bbafc30

Browse files
committed
chore: add commitizen config
1 parent c28f12b commit bbafc30

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,20 @@ npm test
2828

2929
## Donate
3030
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!
31+
32+
## Committing
33+
34+
This project uses [semantic release](https://github.com/semantic-release/semantic-release) to ensure version bumps
35+
follow semver so that projects depending on it don't break unexpectedly.
36+
37+
In order to automatically determine version updates, semantic release expects commit messages to follow the
38+
[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
39+
specification.
40+
41+
You can use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits formatted in this way:
42+
43+
```bash
44+
npm install -g commitizen@latest cz-conventional-changelog@latest
45+
```
46+
47+
Now you're ready to make commits using `git cz`.

package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,10 @@
4242
"web-audio-test-api": "0.5.2",
4343
"webpack": "4.46.0",
4444
"webpack-cli": "3.3.12"
45+
},
46+
"config": {
47+
"commitizen": {
48+
"path": "cz-conventional-changelog"
49+
}
4550
}
4651
}

0 commit comments

Comments
 (0)