Giter VIP home page Giter VIP logo

cz-ovh-commit's Introduction

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

cz-ovh-commit's People

Contributors

antleblanc avatar dependabot[bot] avatar jleveugle avatar ovh-ux-cds avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cz-ovh-commit's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.