Skip to content
A commitizen adapter for ovh
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.editorconfig
.eslintrc.json
.gitignore
LICENSE
README.md
index.js
ovh-config.js
package-lock.json
package.json

README.md

cz-ovh-commit

OVH component

Maintenance Chat on gitter Build Status Commitizen friendly

NPM

Tool for unifying commit style inside OVH

Installation

in a terminal:

  npm i -g commitizen

in the repos:

  npm install --save-dev cz-ovh-commit
  commitizen init cz-ovh-commit --save-dev --save-exact
  git cz -a

customization

You can specify a custom config in your package.json, simply add:

"config": {
  ...
  "cz-ovh-commit": {
    "config": "./path/to/your/config/file"
  }
  ...
}

this file can be either .json or .js. Example of a json file type:

{
  "TYPES": [
      { "value": "feat", "name": "A new feature" },
      { "value": "fix", "name": "A bug fix" },
      { "value": "docs", "name": "Documentation" },
      { "value": "style", "name": "Cosmetics purpose" },
      { "value": "refactor", "name": "Refactor"},
      { "value": "test", "name": "Adding missing or correcting tests" },
      { "value": "chore", "name": "Maintenance" }
  ],
  "EMOJIS": {},
  "useScope": ["feat", "fix", "docs", "style", "refactor", "test", "chore"]
}

You can find more details about the config file in ovh-config.js

Get the sources

    git clone https://github.com/ovh-ux/cz-ovh-commit.git
    cd cz-ovh-commit

You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!

see: CONTRIBUTING.md

Run the tests

no test for the moment

Build the documentation

look in ovh-config.js for building your config file

Related links

License

See https://github.com/ovh-ux/cz-ovh-commit/blob/master/LICENSE

You can’t perform that action at this time.