cz-finiata

0.2.0 • Public • Published

cz-finiata

This is the commitizen setup for Finiata. It mixes together the ideas of both cz-jria-smart-commit and cz-customizable.

Steps

  • Install commitizen if you don't have it
  • Install cz-finiata
  • Add or update .env file in your repository with the following variables
JIRA_USERNAME=<your username>
JIRA_PASSWORD=<your password>

  • Configure commitizen to use cz-finiata
{
  "config": {
    "commitizen": {
      "path": "node_modules/cz-finiata"
    },
    "cz-finiata": {
      "jira": {
        "regex": "<jira issue regex>",
        "version": "<jira api version>",
        "protocol": "<jira server protocol>",
        "host": "<jira server host>"
      }
    }
  }
}

Format

The general format of the commits will look something like this:

feat(Settings) ** ENG-1001 ENG-1002 a mock message thing

some longer type of message that is possible to make you laugh, think and cry

#done closes #45

Commit Type

The first question is about the commit type and it can be one of the following types:

  • feat
  • fix
  • chore
  • refactor
  • test
  • docs

The commit type is related to the issue at large. So, if you're doing a feat and you have a commit that fixes a previous thing in the issue, you should still use feat rather than fix

Scope

The scope of the current issue. This is a bit more general and loose, it could be the name of a module, component, section of the code.

Are there updates to the dependencies

If there are any updates to dependencies in your commit, please add this and it will be used to update other people's code when they pull your changes. It is displayed as two asterisks after the previous two sections.

Issues

This is a list of JIRA and/or Github issues that the current commit affects. They can be space or comma separated:

ENG-1, ENG-3,ENG-5 ENG-23, eng-31 865

will become

ENG-1 ENG-3 ENG-5 ENG-23 ENG-31 865

If you provide the JIRA setup as shown above, it will check to see if the issue you referenced exists in JIRA and return an error if none is found.

Message

You should enter a short simple message about what your commit is doing. Try to keep it less than 40 characters, there is a longer description next

Description

Here you can enter a much longer description about what you want to do with this commit and what it's scope is

Footer

Here you can enter commands that have an effect in Github or Jira such as:

closes #github-issue-number for github or #jira-ticket-status for Jira. They will be appended to the end of the commit and should have an effect in those areas.

Readme

Keywords

none

Package Sidebar

Install

npm i cz-finiata

Weekly Downloads

0

Version

0.2.0

License

MIT

Last publish

Collaborators

  • martin-bb