Installation

Installing prerequisites and get started

Getting Started

Prerequisites

install the package from npm/brew

1. gitflow git extension

   Check installation instructions for your platform.

    brew install git-flow-avh

2. git-chglog

    # CHANGELOG generator
    brew tap git-chglog/git-chglog
    brew install git-chglog

3. Commitizen

     # install and configure `commitizen` git plugin
     yarn global add commitizen cz-conventional-changelog
     echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc; # will create .czrc
     # then you can use commitizen as shown below
     cd non-node-git-repo
     touch foo
     git cz -a

4. SonarLint

   Install SonarLint Plugin for IntelliJ

Usage

Changelog

generate changelog using git-chglog.

# first time
git-chglog --init
# on release branch, generate CHANGELOG.md and commit before merging back to develop & master.
git-chglog
git-chglog -next-tag 2.0.0