👋 Welcome to the @wr-projects/commitizen-config

Table Of Contents

• About the project
• Setup
  • Globally
  • Locally
• Examples
• Configuration
• Usage
• Code Of Conduct
• How to contribute ?
• Contributors
• Project Owner
• Follow us
• License

About the project

Conventional commits with great visibility of emoji

This commitizen adapter adds emoji alongside conventional commit message format from Angular team.

Colorful emojis makes it easy for you to skim through commit log and find certain kinds of commit.

This commitizen adapter basically works same to cz-conventional-changelog.

Setup

Globally

pnpm install commitizen @wr-projects/commitizen-config

# set as default adapter for your projects
echo '{ "path": "@wr-projects/commitizen-config" }' > ~/.czrc

Locally

pnpm install --save-dev commitizen @wr-projects/commitizen-config

Examples

? Select the type of change you are committing: (Use arrow keys)
❯ Initial Commit        🎉   Begin a project. 
  Creation of version   🔖   Begin a project.
  Features              ✨   Introduce new features.
  Bug                   🐛   Fix a bug.
  Hotfix                🚑   Critical hotfix.

Configuration

In order to use, install commitizen and @wr-projects/commitizen-config. Then, just add below to your package.json

"config": {
  "commitizen": {
    "path": "@wr-projects/commitizen-config"
  }
},

Usage

$ git cz

Code Of Conduct

Please read the Code Of Conduct before interacting with the project.

How to contribute ?

In your case, to start contributing, please fork @wr-projects/utils and start working on your part. Later, feel free to contribute a Pull Request, we will be pleased to review it with you.

Contributors

Project Owner

| | | -------------------------------------------------- | | Grégoire FAVREAU |

Follow us

• Support E-mail: Mail
• Discord Channel: Discord

License

MIT LICENSE

Copyright (c) WRProjects Community