Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fetchte/cz-customizable-te
https://github.com/fetchte/cz-customizable-te
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/fetchte/cz-customizable-te
- Owner: fetchTe
- License: mit
- Created: 2017-04-11T22:40:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-21T06:28:14.000Z (about 7 years ago)
- Last Synced: 2024-11-06T23:22:38.294Z (about 2 months ago)
- Language: JavaScript
- Size: 96.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cz-customizable-te
__NOTE__: Same as [cz-customizable](https://github.com/leonardoanalista/cz-customizable), but with the commit tailored to my liking and to jive with [waffle.io](https://waffle.io). It also includes Pivotal commit syntac.
The customizable Commitizen plugin to help achieve consistent commit messages like the [AngularJS team](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).
Suitable for large teams working with multiple projects with their own commit scopes. When you specify the scopes in your `.cz-config.js`, `cz-customizable` allows you to **select** the pre-defined scopes. No more spelling mistakes embarrassing you when generating the changelog file.
## Steps:
* install commitizen in case you don't have it: `npm install -g commitizen`. Make sure you have the latest version of commitizen installed globally.
* install the cz-customizable: `npm install cz-customizable --save-dev`
* configure `commitizen` to use `cz-customizable` as plugin. Add those lines to your `package.json`:
```
...
"config": {
"commitizen": {
"path": "node_modules/cz-customizable"
}
}
```
## You have two options to configure `cz-customizable`:
* Config block in your `package.json`:
```
...
"config": {
"commitizen": {
"path": "node_modules/cz-customizable"
},
"cz-customizable": {
"config": "config/path/to/my/config.js"
}
}
```
Note: option one allows you to have your config away from root directory. It also gives you a change to define any name to your `cz-config.js`.
**Notes:**
* you should commit your `.cz-config.js` file to your git.
From now on, instead of `git commit` you type `git cz` and let the tool do the work for you.
Hopefully this will help you to have consistent commit messages and have a fully automated deployemnt without any human intervention.
## Use Pivotal Commit Syntax, ie `[Finishes #12345689]`:
* Add to your `.cz-config.js` config:
```
module.exports = {
pivotal: true,
...
}
```
## Options
Here are the options you can set in your `.cz-config.js`:
* scopes: {Array of Strings}: Specify the scopes for your particular project. Eg.: for some banking system: ["acccounts", "payments"]. For another travelling application: ["bookings", "search", "profile"]
* scopeOverrides: {Object where key contains a Array of String}: Use this when you want to override scopes for a specific commit type. Example bellow specify scopes when type is `fix`:
```
scopeOverrides: {
fix: [
{name: 'merge'},
{name: 'style'},
{name: 'e2eTest'},
{name: 'unitTest'}
]
}
```
* allowCustomScopes: {boolean, default false}: adds the option `custom` to scope selection so you can still typea scope if you need.
* allowBreakingChanges: {Array of Strings: default none}. List of commit types you would like to the question `breaking change` prompted. Eg.: ['feat', 'fix']
* appendBranchNameToCommitMessage: If you use `cz-customizable` with `cz-customizable-ghooks`, you can get the branch name automatically appended to the commit message. This is done by a commit hook on `cz-customizable-ghooks`. This option has been added on `cz-customizable-ghooks`, v1.3.0. Default value is `true`.
## Related tools:
- (https://github.com/commitizen/cz-cli)
- (https://github.com/stevemao/conventional-recommended-bump)
- (https://github.com/semantic-release/semantic-release)
- (https://github.com/uglow/cz-customizable-ghooks)
## GOTCHAS
* backticks
If you wish to have backticks in your content, for example "feat: \`string\`", the commit preview will be "feat: \\\\`string\\\\`".
Don't worry because on your `git log` will be "feat: \`string\`" as desired.
* multiline contents on the body of the message
Body is the only place where you can use a `pipe` to break lines.
E.g.: you type this: `my items are:| - item01| - item 02`, which will become:
```
my items are:
- item01
- item 02
```
## CONTRIBUTING
Please refer to:
* [Contributor Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md) - disregard section "Signing the CLA"
* [Conduct of Code](https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md) from [AngularJs](https://github.com/angular/angular.js) project.
Leonardo Correa