Skip to content

Commit

Permalink
feat(commits): added commitizen support
Browse files Browse the repository at this point in the history
  • Loading branch information
ashblue committed May 30, 2019
1 parent 4db12ce commit 916f5cb
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,16 @@ If you wish to run to run the development environment you'll need to install [no

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

### Making Commits

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.

To make a commit type the following into a terminal from the root

```bash
npm run commit
```

## Submitting code to this project

Please do the following if you wish to contribute code to this project.
Expand Down
43 changes: 43 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"main": "create-dist.js",
"scripts": {
"build": "node create-dist.js",
"semantic-release": "semantic-release"
"semantic-release": "semantic-release",
"commit": "git-cz"
},
"keywords": [
"ai",
Expand Down Expand Up @@ -36,7 +37,13 @@
"@semantic-release/npm": "^5.1.7",
"@semantic-release/release-notes-generator": "^7.1.4",
"copy-dir": "^1.1.0",
"cz-conventional-changelog": "^2.1.0",
"del": "^4.1.1",
"semantic-release": "^15.13.12"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}

0 comments on commit 916f5cb

Please sign in to comment.