{"id":21186599,"url":"https://github.com/fetchte/cz-customizable-te","last_synced_at":"2025-03-14T20:18:15.050Z","repository":{"id":89445574,"uuid":"87985683","full_name":"fetchTe/cz-customizable-te","owner":"fetchTe","description":null,"archived":false,"fork":false,"pushed_at":"2017-10-21T06:28:14.000Z","size":99,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-06T23:22:38.294Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/fetchTe.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-11T22:40:49.000Z","updated_at":"2023-03-08T03:41:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"dc83afe7-a464-4e09-928e-7d7150157828","html_url":"https://github.com/fetchTe/cz-customizable-te","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"6152aba279a83c76a3414085830f2ce713237174"},"previous_names":["fetchte/cz-customizable-te","artisin/cz-customizable-te"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fetchTe%2Fcz-customizable-te","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fetchTe%2Fcz-customizable-te/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fetchTe%2Fcz-customizable-te/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fetchTe%2Fcz-customizable-te/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fetchTe","download_url":"https://codeload.github.com/fetchTe/cz-customizable-te/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243295472,"owners_count":20268380,"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":[],"created_at":"2024-11-20T18:24:37.216Z","updated_at":"2025-03-14T20:18:15.022Z","avatar_url":"https://github.com/fetchTe.png","language":"JavaScript","readme":"# cz-customizable-te\n\n__NOTE__: Same as [cz-customizable](https://github.com/leonardoanalista/cz-customizable), but with the commit tailored to my liking and to jive with [waffle.io](https://waffle.io). It also includes Pivotal commit syntac.\n\nThe customizable Commitizen plugin to help achieve consistent commit messages like the [AngularJS team](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).\n\n![screenshot](screenshot.png)\n\nSuitable for large teams working with multiple projects with their own commit scopes. When you specify the scopes in your `.cz-config.js`, `cz-customizable` allows you to **select** the pre-defined scopes. No more spelling mistakes embarrassing you when generating the changelog file.\n\n\n\n## Steps:\n* install commitizen in case you don't have it: `npm install -g commitizen`. Make sure you have the latest version of commitizen installed globally.\n* install the cz-customizable: `npm install cz-customizable --save-dev`\n* configure `commitizen` to use `cz-customizable` as plugin. Add those lines to your `package.json`:\n\n  ```\n  ...\n  \"config\": {\n    \"commitizen\": {\n      \"path\": \"node_modules/cz-customizable\"\n    }\n  }\n  ```\n\n## You have two options to configure `cz-customizable`:\n* Config block in your `package.json`:\n  ```\n  ...\n  \"config\": {\n    \"commitizen\": {\n      \"path\": \"node_modules/cz-customizable\"\n    },\n    \"cz-customizable\": {\n      \"config\": \"config/path/to/my/config.js\"\n    }\n  }\n  ```\nNote: option one allows you to have your config away from root directory. It also gives you a change to define any name to your `cz-config.js`.\n\n\n**Notes:**\n* you should commit your `.cz-config.js` file to your git.\n\n\nFrom now on, instead of `git commit` you type `git cz` and let the tool do the work for you.\n\nHopefully this will help you to have consistent commit messages and have a fully automated deployemnt without any human intervention.\n\n## Use Pivotal Commit Syntax, ie `[Finishes #12345689]`:\n* Add to your `.cz-config.js` config:\n  ```\n  module.exports = {\n    pivotal: true,\n    ...\n  }\n  ```\n\n\n\n## Options\n\nHere are the options you can set in your `.cz-config.js`:\n\n* scopes: {Array of Strings}: Specify the scopes for your particular project. Eg.: for some banking system: [\"acccounts\", \"payments\"]. For another travelling application: [\"bookings\", \"search\", \"profile\"]\n* scopeOverrides: {Object where key contains a Array of String}: Use this when you want to override scopes for a specific commit type. Example bellow specify scopes when type is `fix`:\n```\n  scopeOverrides: {\n    fix: [\n      {name: 'merge'},\n      {name: 'style'},\n      {name: 'e2eTest'},\n      {name: 'unitTest'}\n    ]\n  }\n  ```\n  * allowCustomScopes: {boolean, default false}: adds the option `custom` to scope selection so you can still typea scope if you need.\n  * allowBreakingChanges: {Array of Strings: default none}. List of commit types you would like to the question `breaking change` prompted. Eg.: ['feat', 'fix']\n  * appendBranchNameToCommitMessage: If you use `cz-customizable` with `cz-customizable-ghooks`, you can get the branch name automatically appended to the commit message. This is done by a commit hook on `cz-customizable-ghooks`. This option has been added on `cz-customizable-ghooks`, v1.3.0. Default value is `true`.\n\n## Related tools:\n- (https://github.com/commitizen/cz-cli)\n- (https://github.com/stevemao/conventional-recommended-bump)\n- (https://github.com/semantic-release/semantic-release)\n- (https://github.com/uglow/cz-customizable-ghooks)\n\n\n\n## GOTCHAS\n\n* backticks\nIf you wish to have backticks in your content, for example \"feat: \\`string\\`\", the commit preview will be \"feat: \\\\\\\\`string\\\\\\\\`\".\nDon't worry because on your `git log` will be \"feat: \\`string\\`\" as desired.\n\n* multiline contents on the body of the message\nBody is the only place where you can use a `pipe` to break lines.\nE.g.: you type this: `my items are:| - item01| - item 02`, which will become:\n\n\n```\nmy items are:\n - item01\n - item 02\n```\n\n\n## CONTRIBUTING\n\nPlease refer to:\n* [Contributor Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md) - disregard section \"Signing the CLA\"\n* [Conduct of Code](https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md) from [AngularJs](https://github.com/angular/angular.js) project.\n\n\n\nLeonardo Correa\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffetchte%2Fcz-customizable-te","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffetchte%2Fcz-customizable-te","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffetchte%2Fcz-customizable-te/lists"}