ngryman / cz-emoji

Commitizen adapter formatting commit messages using emojis.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Example Repos

ariesshrimp opened this issue Β· comments

A list of example repos using this commit convention in the readme would be helpful. It's hard to figure out how best to integrate this into a release cycle.

Sure, what about a link in the readme to propose anyone using cz-emoji to add a repo to the list?

A little late sorry, I added a section for that.

@ngryman

Updated link, sorry about that: Falieson/TRAM@9f3c380#diff-b9cfc7f2cdf78a7f4b91a753d10865a2

Snippet for posterity

  "config": {
    "cz-emoji": {
      "types":[
        {
          "name": "feat \t\t🌟  A new feature",
          "value": ":star2:"
        },
        {
          "name": "fix \t\t🐞  A bug fix",
          "value": ":beetle:"
        },
        {
          "name": "test \t\tπŸš“  Testing improved with new or fixed tests",
          "value": ":police_car:"
        },
        {
          "name": "chore \tπŸ”©  Doesn't modify src or test files",
          "value": ":nut_and_bolt:"
        },
        {
          "name": "style \t✏️  Doesn't affect the meaning of the code (white-space, semi-colons, etc)",
          "value": ":pencil2:"
        },
        {
          "name": "docs \t\tπŸ“š  Documentation change",
          "value": ":books:"
        },
        {
          "name": "refactor \t🎨  Neither fixes a bug nor adds a feature",
          "value": ":art:"
        },
        {
          "name": "perf \t\tπŸ’°  Improves performance with this change",
          "value": ":moneybag:"
        },
        {
          "name": "build \tπŸš€  Build system config or external dependencies ($compile)",
          "value": ":rocket:"
        },
        {
          "name": "ci \t\tπŸš₯  CI config files and scripts ($arch)",
          "value": ":traffic_light:"
        },
        {
          "name": "revert \tπŸ’Š  Reverts a previous commit",
          "value": ":pill:"
        }
      ],
      "scopes": [
        "arch",
        "compile",
        "contrib",
        "core",
        "data",
        "ui"
      ]
    },
    "commitizen": {
      "path": "./node_modules/cz-emoji"
    }
  },```