git-cz-for-api-developer v1.0.4

git-cz-for-api-developer

A fork of git-cz.

1) Adds relese types (major, minor, patch and etc)

Without installation

npx git-cz-api

Install globally standalone

npm install -g git-cz-for-api-developer
git-cz-api

Install locally with Commitizen

npm install -g commitizen
npm install --save-dev git-cz-for-api-developer

package.json:

{
  "config": {
    "commitizen": {
      "path": "git-cz-for-api-developer"
    }
  },
}

run:

git cz

Install globally with Commitizen

npm install -g commitizen git-cz-for-api-developer
commitizen init git-cz-for-api-developer --save-dev --save-exact

run:

git cz

Commit Message Format

• A commit message consists of a header, body and footer.
• The header has a releaseType and type and a subject:

<releaseType>-<type>[(<scope>)]: <emoji> <subject>
[BLANK LINE]
[body]
[BLANK LINE]
[breaking changes]
[BLANK LINE]
[footer]

The header is the only mandatory part of the commit message.

The first line (type + subject) is limited to 50 characters enforced

Any other line should be limited to 72 character automatic wrapping

This allows the message to be easier to read on GitHub as well as in various git tools.

Release Type

Must be one of the following:

• major — major update
• minor — minor update
• patch — patch update

Type

Must be one of the following:

• test — Adding missing tests
• feat — A new feature
• fix — A bug fix
• chore — Build process or auxiliary tool changes
• docs — Documentation only changes
• refactor — A code change that neither fixes a bug or adds a feature
• style — Markup, white-space, formatting, missing semi-colons...
• ci — CI related changes
• perf — A code change that improves performance

Subject

The subject contains succinct description of the change:

• Use the imperative, present tense: "change" not "changed" nor "changes"
• No dot (.) at the end.

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Affects [only on lerna environments]

Select the packages the commit affected.

Breaking Changes

Breaking Changes must start with the words BREAKING CHANGE:.

Footer

The footer is the place to reference any tasks related to this commit.

Why this Fork?

npm i -g git-cz-for-api-developer
added 1 package in 0.612s

Installs in 0.6s vs 31.1s.

npm i -g mol-conventional-changelog
added 345 packages in 31.076s