{"id":14155409,"url":"https://github.com/RedJue/git-commit-plugin","last_synced_at":"2025-08-06T01:31:19.839Z","repository":{"id":37688655,"uuid":"242101648","full_name":"RedJue/git-commit-plugin","owner":"RedJue","description":"Automatically generate git commit","archived":false,"fork":false,"pushed_at":"2024-05-23T09:02:19.000Z","size":2331,"stargazers_count":175,"open_issues_count":4,"forks_count":45,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-23T09:53:11.555Z","etag":null,"topics":["commit","git","hacktoberfest","specification","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=redjue.git-commit-plugin","language":"TypeScript","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/RedJue.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":"2020-02-21T09:26:42.000Z","updated_at":"2024-06-09T11:53:51.761Z","dependencies_parsed_at":"2024-01-14T04:43:09.059Z","dependency_job_id":"63005481-ce3b-42ab-b877-465c5b938c4d","html_url":"https://github.com/RedJue/git-commit-plugin","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/RedJue%2Fgit-commit-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedJue%2Fgit-commit-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedJue%2Fgit-commit-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedJue%2Fgit-commit-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RedJue","download_url":"https://codeload.github.com/RedJue/git-commit-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228821405,"owners_count":17977166,"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":["commit","git","hacktoberfest","specification","vscode-extension"],"created_at":"2024-08-17T08:03:03.562Z","updated_at":"2024-12-09T02:31:20.944Z","avatar_url":"https://github.com/RedJue.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","vscode-extension"],"sub_categories":[],"readme":"# Git Commit Plugin For VS Code\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\u003e Automatically generate git commit messages\n\n![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/redjue.git-commit-plugin)\n![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/redjue.git-commit-plugin)\n![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/redjue.git-commit-plugin)\n![Visual Studio Marketplace Rating (Stars)](https://img.shields.io/visual-studio-marketplace/stars/redjue.git-commit-plugin)\n![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/redjue.git-commit-plugin)\n![GitHub contributors](https://img.shields.io/github/contributors/RedJue/git-commit-plugin)\n![GitHub last commit](https://img.shields.io/github/last-commit/RedJue/git-commit-plugin)\n![GitHub](https://img.shields.io/github/license/RedJue/git-commit-plugin?color=green)\n\n\n## Requirements\n\n- VS Code `1.42.0` or higher.\n- VS Code's built-in Git plugin \n\n## Format\n\nThis extension follows the [Angular Team Commit Specification](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines), as follows:\n\n```\n\u003ctype\u003e(\u003cscope\u003e): \u003csubject\u003e\n\u003cBLANK LINE\u003e\n\u003cbody\u003e\n\u003cBLANK LINE\u003e\n\u003cfooter\u003e\n```\n\nSee info on the fields below.\n\n### Type\n\nMust be one of the following:\n\nType | Description\n---  | ---\n**feat** | A new feature\n**fix** | A bug fix\n**docs** | Documentation only changes\n**style**: | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n**refactor** | A code change that neither fixes a bug nor adds a feature\n**perf** | A code change that improves performance\n**test** | Adding missing or correcting existing tests\n**chore** | Changes to the build process or auxiliary tools and libraries such as documentation generation\n\n### Scope\n\nThe scope could be anything specifying place of the commit change. For example `$location`, `$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...\n\nYou can use `*` when the change affects more than a single scope.\n\n### Subject\n\nThe subject contains succinct description of the change:\n\n-   use the imperative, present tense: \"change\" not \"changed\" nor \"changes\"\n-   don't capitalize first letter\n-   no dot (`.`) at the end\n\n### Body\n\nJust as in the **subject**, use the imperative, present tense: \"change\" not \"changed\" nor \"changes\". The body should include the motivation for the change and contrast this with previous behavior.\n\n### Footer\n\nThe footer should contain any information about **Breaking Changes** and is also the place to [reference GitHub issues that this commit closes](https://help.github.com/articles/closing-issues-via-commit-messages/).\n\n**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.\n\nA detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#).\n\n## Quick Start\n\n1. Install the plugin\n1. Use the command shortcut `showGitCommit` to open the command window or Click the icon on the git plugin navigation bar\n    ![open](/assets/open.gif)\n1. Enter the commit information, which automatically generates a commit message that conforms to the specification\n    ![edit](/assets/edit.gif)\n\n## Locale Support\nThe plugin will automatically switch the language description based on the `vscode` language environment.\n\n**Support Language**\n- en-US as default\n- zh-CN\n- zh-HK\n- zh-TW\n- ja-JP\n\n## Settings Options\n\n-   `GitCommitPlugin.ShowEmoji`: whether to show emoji, default `true`.\n    ```json\n    {\n      \"GitCommitPlugin.ShowEmoji\": true\n    }\n    ```\n-   `GitCommitPlugin.CustomCommitType`: customize the commit type, default `null`.\n    ```json5\n    { \n      \"GitCommitPlugin.CustomCommitType\": [\n        \"customTypeName\"\n      ]\n    }\n    ```\n    or\n    ```json5\n    [\n       {\n           // If there are duplicate keys, rewrite the config，otherwise add As a new configuration addition\n           \"key\": \"customTypeKey\", \n           \"label\": \"customTypeName\",\n           \"detail\": \"customTypeDetail\",\n           \"icon\":\"customIcon\"\n       }\n    ]\n    ```\n-   `GitCommitPlugin.MaxSubjectCharacters`: customize the maximum number of words on the subject, default `20`.\n    ```json\n    {\n      \"GitCommitPlugin.MaxSubjectCharacters\": 20\n    }\n    ```\n-  `GitCommitPlugin.FillSubjectWithCurrent`: whether to fill the subject with the current commit message, default `false`.\n    ```json\n    {\n      \"GitCommitPlugin.FillSubjectWithCurrent\": false\n    }\n    ```\n-   `GitCommitPlugin.Template`: customize the git commit template.\n    ```json5\n    {\n      \"GitCommitPlugin.Templates\": [\n        {\n            \"templateName\": \"Angular\",\n            \"templateContent\": \"\u003cicon\u003e\u003cspace\u003e\u003ctype\u003e(\u003cscope\u003e):\u003cspace\u003e\u003csubject\u003e\u003center\u003e\u003cbody\u003e\u003center\u003e\u003cfooter\u003e\"\n        },\n        {\n            \"templateName\": \"git-cz\",\n            \"templateContent\": \"\u003ctype\u003e(\u003cscope\u003e):\u003cspace\u003e\u003cicon\u003e\u003cspace\u003e\u003csubject\u003e\u003center\u003e\u003cbody\u003e\u003center\u003e\u003cfooter\u003e\",\n             // Set as default commit template\n            \"default\":true\n        }\n      ]\n    }\n    ```\n\n## License\n\nReleased under [MIT](/LICENSE) by [@RedJue](https://github.com/RedJue).\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.imalun.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/31614024?v=4?s=100\" width=\"100px;\" alt=\"白云苍狗\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003e白云苍狗\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=MaLuns\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/Tiddler-7\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/73354813?v=4?s=100\" width=\"100px;\" alt=\"冷空气\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003e冷空气\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=Tiddler-7\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://my.hancel.org\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1502581?v=4?s=100\" width=\"100px;\" alt=\"Hancel Lin\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eHancel Lin\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=imlinhanchao\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/Torlinone\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/26668466?v=4?s=100\" width=\"100px;\" alt=\"Keriy\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKeriy\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=Torlinone\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://www.linkedin.com/in/arthurmeyniel\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/61516506?v=4?s=100\" width=\"100px;\" alt=\"Arthur Meyniel\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eArthur Meyniel\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=ArthurMynl\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/haryoiro\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/55312590?v=4?s=100\" width=\"100px;\" alt=\"haryoiro\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eharyoiro\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=haryoiro\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/DrBlackBird\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10115809?v=4?s=100\" width=\"100px;\" alt=\"Tom\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTom\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=DrBlackBird\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://www.webwuyou.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/15182683?v=4?s=100\" width=\"100px;\" alt=\"风过无痕\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003e风过无痕\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=webwuyou\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/whwnow\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1713701?v=4?s=100\" width=\"100px;\" alt=\"whwnow\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ewhwnow\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=whwnow\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/MichaelCurrin\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/18750745?v=4?s=100\" width=\"100px;\" alt=\"Michael Currin\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMichael Currin\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=MichaelCurrin\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.odinsam.com/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/68220289?v=4?s=100\" width=\"100px;\" alt=\"odinsam\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eodinsam\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=odinsam\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/tys1128\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/24326849?v=4?s=100\" width=\"100px;\" alt=\"tys1128\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003etys1128\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=tys1128\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://mlzzen.vercel.app\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/11664505?v=4?s=100\" width=\"100px;\" alt=\"mlzzen\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003emlzzen\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=mlzzen\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/yeze322\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/8528761?v=4?s=100\" width=\"100px;\" alt=\"zeye\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ezeye\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=yeze322\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://blog.moeyua.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/45156493?v=4?s=100\" width=\"100px;\" alt=\"Moeyua\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMoeyua\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RedJue/git-commit-plugin/commits?author=moeyua\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRedJue%2Fgit-commit-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRedJue%2Fgit-commit-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRedJue%2Fgit-commit-plugin/lists"}