build-utils.cz-adapter

A commitizen adapter for heed service repositories

Installation

the comittizen adapter requires comittizen to be installed as a dev dependency on the project.

yarn add @heed/build-utils.cz-adapter commitizen

Then add the adapter to the comittizen config in package.json

{
  "config": {
    "comittizen": {
      "path": "@heed/build-utils.cz-adapter"
    }
  }
}

And add a script to run commits in package.json

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

Making commits

To make a commit, first stage the changes in git

git add somefile.js other/files/

Then run the commit script

yarn run commit

You will be guided through the questions and the commit will be formatted for you.

:bug: (bug) Fix An issue with a thing not working

This thing didnt work so i fixed it an now it
does work

HEED-123
HEED-456

Notes

The adapter will make a guess at the task you are working on from your current branch name. So name your branches so they contain the id like: HEED-4564-something