@vmo11/cz-jira-smart-commit

A commitizen adapter for Jira smart commits

Usage no npm install needed!

<script type="module">
  import vmo11CzJiraSmartCommit from 'https://cdn.skypack.dev/@vmo11/cz-jira-smart-commit';
</script>

README

cz-jira-smart-commit

A commitizen adapter for Jira smart commits.

Screenshot

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

Use commitizen to init

yarn add -D commitizen
./node_modules/.bin/commitizen init @vmo11/cz-jira-smart-commit --yarn --dev --exact

Or manual install this adapter

npm install cz-jira-smart-commit

Reference it in your .cz.json of your project

{
  "path": "node_modules/cz-jira-smart-commit/"
}

Update package.json file

{
    ...
    "scripts": {
        ...
        "commit": "git cz"
    }
}

Day to day work

Instead of git commit -m 'Your message', you type: yarn commit with this adapter and it prompts you for:

  • Jira Issue Key(s)
  • commit message
  • Workflow command
  • Time Spent
  • Comment

And generates your commit based on that.