https://github.com/commitizen/cz-jira-smart-commit
A commitizen adapter for Jira Smart Commits
https://github.com/commitizen/cz-jira-smart-commit
Last synced: 8 months ago
JSON representation
A commitizen adapter for Jira Smart Commits
- Host: GitHub
- URL: https://github.com/commitizen/cz-jira-smart-commit
- Owner: commitizen
- Created: 2015-08-07T21:20:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-06-06T22:46:27.000Z (over 5 years ago)
- Last Synced: 2025-04-21T10:54:26.644Z (8 months ago)
- Language: JavaScript
- Homepage: https://confluence.atlassian.com/display/FISHEYE/Using+smart+commits
- Size: 83 KB
- Stars: 114
- Watchers: 8
- Forks: 48
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cz-jira-smart-commit
A commitizen adapter for [Jira smart commits](https://confluence.atlassian.com/display/FISHEYE/Using+smart+commits).

## Usage
### Global Installation
For a quick global installation of the plugin, simply run the `install.sh` script present in this repo:
```
chmod +x install.sh
./install.sh
```
### Add this adapter
Install this adapter
```
npm install cz-jira-smart-commit
```
Reference it in your `.cz.json` of your project
```json
{
"path": "node_modules/cz-jira-smart-commit/"
}
```
or use commitizen to init
```
commitizen init cz-jira-smart-commit
```
### Day to day work
Instead of `git commit -m 'Your message'`, you type: `git cz` with this adapter and it prompts you for:
- commit message
- Jira Issue Key(s)
- Workflow command
- Time Spent
- Comment
And generates your commit based on that.