Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RedJue/git-commit-plugin
Automatically generate git commit
https://github.com/RedJue/git-commit-plugin
commit git hacktoberfest specification vscode-extension
Last synced: 3 months ago
JSON representation
Automatically generate git commit
- Host: GitHub
- URL: https://github.com/RedJue/git-commit-plugin
- Owner: RedJue
- License: mit
- Created: 2020-02-21T09:26:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T09:02:19.000Z (6 months ago)
- Last Synced: 2024-05-23T09:53:11.555Z (6 months ago)
- Topics: commit, git, hacktoberfest, specification, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=redjue.git-commit-plugin
- Size: 2.22 MB
- Stars: 175
- Watchers: 5
- Forks: 45
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Commit Plugin For VS Code
[](#contributors-)
> Automatically generate git commit messages
## Requirements
- VS Code `1.42.0` or higher.
- VS Code's built-in Git plugin
## Format
This extension follows the [Angular Team Commit Specification](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines), as follows:
```
():
```
See info on the fields below.
### Type
Must be one of the following:
Type | Description
--- | ---
**feat** | A new feature
**fix** | A bug fix
**docs** | Documentation only changes
**style**: | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
**refactor** | A code change that neither fixes a bug nor adds a feature
**perf** | A code change that improves performance
**test** | Adding missing or correcting existing tests
**chore** | Changes to the build process or auxiliary tools and libraries such as documentation generation
### Scope
The scope could be anything specifying place of the commit change. For example `$location`, `$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
You can use `*` when the change affects more than a single scope.
### Subject
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (`.`) at the end
### Body
Just 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.
### Footer
The 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/).
**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.
A detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#).
## Quick Start
1. Install the plugin
1. Use the command shortcut `showGitCommit` to open the command window or Click the icon on the git plugin navigation bar
1. Enter the commit information, which automatically generates a commit message that conforms to the specification
## Locale Support
The plugin will automatically switch the language description based on the `vscode` language environment.
**Support Language**
- en-US as default
- zh-CN
- zh-HK
- zh-TW
- ja-JP
## Settings Options
- `GitCommitPlugin.ShowEmoji`: whether to show emoji, default `true`.
```json
{
"GitCommitPlugin.ShowEmoji": true
}
```
- `GitCommitPlugin.CustomCommitType`: customize the commit type, default `null`.
```json5
{
"GitCommitPlugin.CustomCommitType": [
"customTypeName"
]
}
```
or
```json5
[
{
// If there are duplicate keys, rewrite the config，otherwise add As a new configuration addition
"key": "customTypeKey",
"label": "customTypeName",
"detail": "customTypeDetail",
"icon":"customIcon"
}
]
```
- `GitCommitPlugin.MaxSubjectCharacters`: customize the maximum number of words on the subject, default `20`.
```json
{
"GitCommitPlugin.MaxSubjectCharacters": 20
}
```
- `GitCommitPlugin.FillSubjectWithCurrent`: whether to fill the subject with the current commit message, default `false`.
```json
{
"GitCommitPlugin.FillSubjectWithCurrent": false
}
```
- `GitCommitPlugin.Template`: customize the git commit template.
```json5
{
"GitCommitPlugin.Templates": [
{
"templateName": "Angular",
"templateContent": "():"
},
{
"templateName": "git-cz",
"templateContent": "():",
// Set as default commit template
"default":true
}
]
}
```
## License
Released under [MIT](/LICENSE) by [@RedJue](https://github.com/RedJue).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
白云苍狗
💻
冷空气
📖
Hancel Lin
💻
Keriy
💻
Arthur Meyniel
💻
haryoiro
📖
Tom
📖
风过无痕
💻
whwnow
💻
Michael Currin
📖
odinsam
💻
tys1128
📖
mlzzen
💻
zeye
💻
Moeyua
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!