git-commit-guide v1.0.0

git Commit Guide

Part of the commitizen family. Prompts for conventional changelog standard and also prompts for a mandatory JIRA issue.

Adds Smart commits functionality in @digitalroute/cz-conventional-changelog-for-jira

Features

• Works seamlessly with semantic-release 🚀
• Works seamlessly with Jira smart commits
• Automatically detects the Jira issue from the branch name

Quickstart

Installation

npm install commitizen git-commit-guide

and then add the following to package.json:

{
  "scripts": {
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/git-commit-guide"
    }
  }
}

Install Globally

Create a .czrc file in your home directory, with path referring to the preferred, globally installed, commitizen adapter

echo '{ "path": "./node_modules/git-commit-guide" }' > ~/.czrc

After commitizen has been installed, instead of making a commit with git commit you make a commit with:

git cz

Configuration

Like commitizen, you can specify the configuration of cz-conventional-changelog-for-jira through the package.json's config.commitizen key, or with environment variables.

Dynamic Configuration

Alternatively, if you want to create your own profile, you can use the configurable approach. Here is an example: ./index.js

const custom = require('git-commit-guide/configurable');
// You can do this optionally if you want to extend the commit types
const defaultTypes = require('git-commit-guide/types');

module.exports = custom({
  types: {
    ...defaultTypes,
    perf: {
      description: 'Improvements that will make your code perform better',
      title: 'Performance'
    }
  },
  skipScope: false,
  scopes: ['myScope1', 'myScope2']
});

./package.json

{
  "config": {
    "commitizen": {
      "path": "./index.js"
    }
  }
}

This example would:

• Display "perf" as an extra commit type
• Ask you to add a commit scope
• Limit the scope selection to either myScope or myScope2

List of all supported configurable options when using the configurable approach:

Commitlint

If using the commitlint js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 72. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.