Skip to content

Commit

Permalink
chore(scripts): add commit script, cz-customizable (#612)
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvdutt committed Sep 28, 2018
1 parent 473676d commit f265142
Show file tree
Hide file tree
Showing 4 changed files with 223 additions and 3 deletions.
3 changes: 1 addition & 2 deletions .cz-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ module.exports = {
// sort type values in asc
types: [
{ value: "ast", name: "ast: init, migrate, add, etc" },
{ value: "break", name: "break: changes that break the behaviour of the cli" },
{ value: "break", name: "break: Changes that break the behaviour of the cli" },
{ value: "chore", name: "chore: Updating deps, docs, linting, etc" },
{ value: "cli", name: "cli: Core CLI things" },
{ value: "docs", name: "docs: Documentation" },
{ value: "feat", name: "feat: A new feature" },
{ value: "fix", name: "fix: Bugs, typos, etc" },
{ value: "misc", name: "misc: Other formats like tweaks and such" },
{ value: "tests", name: "tests: Tests, jest, binTestCases, etc" },
{ value: "break", name: "break: changes that break the behaviour of the cli" }
]
};
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ In case you've got a small change in most of the cases your pull request would b

Our commit messages format follows the [angular.js commits format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format).

You can use `npm run commit` script to have an interactive way for making commits that follow our guidelines.

We don't use the scope. The template of a commit would look like this:

### Commit Message Format
Expand All @@ -123,14 +125,14 @@ format that includes a **type** and a **subject**:

This is the list of *type* of commits that we accept:
* ast
* break
* chore
* cli
* docs
* feat
* fix
* misc
* tests
* break

The **header** is mandatory.

Expand Down
217 changes: 217 additions & 0 deletions package-lock.json

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

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"bundlesize": "bundlesize",
"changelog": "conventional-changelog --config ./build/changelog-generator/index.js --infile CHANGELOG.md --same-file",
"clean:all": "rimraf node_modules packages/*/node_modules",
"commit": "git-cz",
"docs": "typedoc",
"format": "prettier-eslint ./bin/*.js ./test/**/*.js ./packages/**/*.js --write",
"lint:codeOnly": "eslint \"{bin}/**/!(__testfixtures__)/*.js\" \"{bin}/**.js\"",
Expand Down Expand Up @@ -133,6 +134,7 @@
"commitizen": "^2.10.1",
"commitlint-config-cz": "^0.10.1",
"conventional-changelog-cli": "^2.0.5",
"cz-customizable": "^5.2.0",
"eslint": "^5.5.0",
"eslint-plugin-node": "^7.0.1",
"husky": "^1.0.0",
Expand Down

0 comments on commit f265142

Please sign in to comment.