Skip to content

Commit def2c92

Browse files
committed
chore: add commitizen config
1 parent cc4f0db commit def2c92

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,20 @@ npm test
6868

6969
## Donate
7070
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!
71+
72+
## Committing
73+
74+
This project uses [semantic release](https://github.com/semantic-release/semantic-release) to ensure version bumps
75+
follow semver so that projects depending on it don't break unexpectedly.
76+
77+
In order to automatically determine version updates, semantic release expects commit messages to follow the
78+
[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
79+
specification.
80+
81+
You can use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits formatted in this way:
82+
83+
```bash
84+
npm install -g commitizen@latest cz-conventional-changelog@latest
85+
```
86+
87+
Now you're ready to make commits using `git cz`.

package.json

+5
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,10 @@
6363
"scratch-storage": "^1.0.0",
6464
"scratch-svg-renderer": "0.2.0",
6565
"twgl.js": "4.4.0"
66+
},
67+
"config": {
68+
"commitizen": {
69+
"path": "cz-conventional-changelog"
70+
}
6671
}
6772
}

0 commit comments

Comments
 (0)