{"id":16860453,"url":"https://github.com/pvdlg/cz-conventional-commit","last_synced_at":"2025-04-11T08:33:42.818Z","repository":{"id":66097244,"uuid":"100132547","full_name":"pvdlg/cz-conventional-commit","owner":"pvdlg","description":"Commitizen adapter following the conventional-changelog format, with emojis. 🎉","archived":false,"fork":false,"pushed_at":"2020-03-27T05:17:14.000Z","size":271,"stargazers_count":16,"open_issues_count":2,"forks_count":9,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T17:01:38.259Z","etag":null,"topics":["command-line","commit-hooks","commitizen","commitizen-adapter","conventional-commits","emoji","git"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pvdlg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-12T19:05:49.000Z","updated_at":"2024-12-24T07:51:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"744f4862-345c-4070-ba61-7724f2014dca","html_url":"https://github.com/pvdlg/cz-conventional-commit","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvdlg%2Fcz-conventional-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvdlg%2Fcz-conventional-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvdlg%2Fcz-conventional-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvdlg%2Fcz-conventional-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pvdlg","download_url":"https://codeload.github.com/pvdlg/cz-conventional-commit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248361678,"owners_count":21090962,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","commit-hooks","commitizen","commitizen-adapter","conventional-commits","emoji","git"],"created_at":"2024-10-13T14:24:17.790Z","updated_at":"2025-04-11T08:33:42.785Z","avatar_url":"https://github.com/pvdlg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **cz-conventional-commit**\n\n[commitizen](https://github.com/commitizen/cz-cli) adapter following the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) format, with emojis and additionnal commit types (aliases).\n\n[![Travis](https://img.shields.io/travis/pvdlg/cz-conventional-commit.svg)](https://travis-ci.org/pvdlg/cz-conventional-commit)\n[![Codecov](https://img.shields.io/codecov/c/github/pvdlg/cz-conventional-commit.svg)](https://codecov.io/gh/pvdlg/cz-conventional-commit)\n[![Greenkeeper badge](https://badges.greenkeeper.io/pvdlg/cz-conventional-commit.svg)](https://greenkeeper.io/)\n[![license](https://img.shields.io/github/license/pvdlg/cz-conventional-commit.svg)](https://github.com/pvdlg/cz-conventional-commit/blob/master/LICENSE)\n\n![Screenshot](img/cz-conventional-commit.jpg?raw=true)\n\n## Install as a global utility\n\n```bash\nnpm install --global commitizen @metahub/cz-conventional-commit\n```\nCreate a .czrc file in your home directory, with the following content:\n```json\n{\n  \"path\": \"@metahub/cz-conventional-commit\",\n  \"cz-conventional-commit\": {\n    \"maxSubjectLength\": 72,\n    \"bodyLineLength\": 100\n  }\n}\n```\nNow cd into any git repository and use `git cz` instead of `git commit` and you will find the commitizen prompt.\n\nSee [commitizen documentation](https://github.com/commitizen/cz-cli#conventional-commit-messages-as-a-global-utility) for more informations.\n\n## Making your repo Commitizen-friendly\n```bash\nnpm install --save-dev commitizen @metahub/cz-conventional-commit\n./node_modules/.bin/commitizen init @metahub/cz-conventional-commit --save-dev\n```\nYou can customize cz-conventional-commit in `package.json`:\n```json\n...\n\"config\": {\n  \"commitizen\": {\n    \"path\": \"@metahub/cz-conventional-commit\",\n    \"cz-conventional-commit\": {\n      \"maxSubjectLength\": 72,\n      \"bodyLineLength\": 100,\n      \"emoji\": true\n    }\n  }\n}\n...\n```\n\nSee [commitizen documentation](https://github.com/commitizen/cz-cli#making-your-repo-commitizen-friendly) for more informations.\n\n## Options\n\n| Option             | Description                                                                                | Default |\n| ------------------ | ------------------------------------------------------------------------------------------ | ------- |\n| `maxSubjectLength` | Length at which to truncate the commit head (head includes type, scope, subject and emoji) | 72      |\n| `bodyLineLength`   | Length at which to wrap body lines                                                         | 100     |\n| `emoji`            | To add and emoji at the end of the commit message                                          | `false` |\n\n## Commit types\n\n| Commit Type | Title                    | Description                                                                                                 | Emoji |\n|-------------|--------------------------|-------------------------------------------------------------------------------------------------------------|:-----:|\n| `feat`      | Features                 | A new feature                                                                                               |   ✨   |\n| `fix`       | Bug Fixes                | A bug Fix                                                                                                   |  🐛   |\n| `docs`      | Documentation            | Documentation only changes                                                                                  |  📚   |\n| `style`     | Styles                   | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)      |  💎   |\n| `refactor`  | Code Refactoring         | A code change that neither fixes a bug nor adds a feature                                                   |  📦   |\n| `perf`      | Performance Improvements | A code change that improves performance                                                                     |  🚀   |\n| `test`      | Tests                    | Adding missing tests or correcting existing tests                                                           |  🚨   |\n| `build`     | Builds                   | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)         |  🛠   |\n| `ci`        | Continuous Integrations  | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |   ⚙️  |\n| `chore`     | Chores                   | Other changes that don't modify src or test files                                                           |   ♻️  |\n| `revert`    | Reverts                  | Reverts a previous commit                                                                                   |  🗑   |\n\n## Commit aliases\n\nAliases are additionnal commit types that will be formatted to follow [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) and automatically set some fields.\n\nFor example when choosing `initial`, `cz-conventional-commit` will automatically set:\n- the standard type to `feat`\n- the `scope` to empty\n- the `subject` to 'Initial commit 🎉'\n- the `issues` to empty\n- the `breaking` to empty\n\nThe commit message will be `feat: Initial commit 🎉`.\n\n| Commit Type        | Type    | Scope (default) | Subject (default) | Emoji |\n|--------------------|---------|-----------------|-------------------|:-----:|\n| `initial`          | `feat`  | `empty`         | Initial commit    |  🎉   |\n| `dependencies`     | `fix`   | package         | -                 |   ⏫   |\n| `peerDependencies` | `fix`   | package         | -                 |   ⬆️  |\n| `devDependencies`  | `chore` | package         | -                 |  🔼   |\n| `metadata`         | `fix`   | package         | -                 |  📦   |\n\n## Related\n\n- [conventional-changelog-metahub](https://github.com/pvdlg/conventional-changelog-metahub) - List of conventional commit types and aliases for this module\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpvdlg%2Fcz-conventional-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpvdlg%2Fcz-conventional-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpvdlg%2Fcz-conventional-commit/lists"}