chore: configure and document commitizen

README.md

@@ -3,3 +3,20 @@
 Fonts for Scratch SVG rendering
 
 [![CI/CD](https://github.com/scratchfoundation/scratch-render-fonts/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/scratchfoundation/scratch-render-fonts/actions/workflows/ci-cd.yml)
+
+## 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.
+
+Use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits formatted in this way:
+
+```bash
+npm install -g commitizen
+```
+
+Now you're ready to make commits using `git cz`.

package.json

@@ -4,6 +4,7 @@
   "description": "",
   "main": "./src/index.js",
   "author": "Massachusetts Institute of Technology",
+  "homepage": "https://github.com/scratchfoundation/scratch-render-fonts#readme",
   "repository": {
     "type": "git",
     "url": "git+ssh://[email protected]/scratchfoundation/scratch-render-fonts.git"
@@ -15,7 +16,11 @@
     "test": "npm run build",
     "watch": "webpack --progress --watch"
   },
-  "homepage": "https://github.com/scratchfoundation/scratch-render-fonts#readme",
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
   "dependencies": {
     "base64-loader": "1.0.0"
   },