Skip to content

Commit 916f5cb

Browse files
committed
feat(commits): added commitizen support
1 parent 4db12ce commit 916f5cb

File tree

3 files changed

+61
-1
lines changed

3 files changed

+61
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,16 @@ If you wish to run to run the development environment you'll need to install [no
567567

568568
If you wish to create a build run `npm run build` from the root and it will populate the `dist` folder.
569569

570+
### Making Commits
571+
572+
All commits should be made using [Commitizen](https://github.com/commitizen/cz-cli) (which is automatically installed when running `npm install`). Commits are automatically compiled to version numbers on release so this is very important. PRs that don't have Commitizen based commits will be rejected.
573+
574+
To make a commit type the following into a terminal from the root
575+
576+
```bash
577+
npm run commit
578+
```
579+
570580
## Submitting code to this project
571581

572582
Please do the following if you wish to contribute code to this project.

package-lock.json

Lines changed: 43 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"main": "create-dist.js",
88
"scripts": {
99
"build": "node create-dist.js",
10-
"semantic-release": "semantic-release"
10+
"semantic-release": "semantic-release",
11+
"commit": "git-cz"
1112
},
1213
"keywords": [
1314
"ai",
@@ -36,7 +37,13 @@
3637
"@semantic-release/npm": "^5.1.7",
3738
"@semantic-release/release-notes-generator": "^7.1.4",
3839
"copy-dir": "^1.1.0",
40+
"cz-conventional-changelog": "^2.1.0",
3941
"del": "^4.1.1",
4042
"semantic-release": "^15.13.12"
43+
},
44+
"config": {
45+
"commitizen": {
46+
"path": "./node_modules/cz-conventional-changelog"
47+
}
4148
}
4249
}

0 commit comments

Comments
 (0)