vscode-git-semantic-commit
vscode-git-semantic-commit copied to clipboard
๐ฌ A Visual Studio Code extension which enables to commit simply by the semantic message conventions
VS Code - Git Semantic Commit
Installation ยท Usage ยท Settings ยท CHANGELOG
โน๏ธ๏ธ Description
This Visual Studio Code extension enables to commit simply by the semantic message conventions.
Notice that the default types are aligned with the Angular commit message conventions.
๐จ๐ปโ๐ซ How to Use
The first thing you need to do is installing the extension.
Well, there are two ways to trigger the "Semantic Commit" command:
1. Command Palette
Open the Command Palette and start typing Git: Semantic Commit
:
Then, choose the appropriate command and follow the steps.
2. View Actions
Alternatively, you can use the primary and secondary actions within the Source Control view:
โ๏ธ Settings
The extension allows you to customize the following configuration settings:
Name | Description |
---|---|
gitSemanticCommit.commitOptions |
Specifies which arguments to be passed when the commit is executed |
gitSemanticCommit.preserveScope |
Determines whether to preserve the last message scope that was inserted |
gitSemanticCommit.scopeTemplate |
Specifies scope template ($scope placeholder will be replaced with the passed scope) |
gitSemanticCommit.stageAll |
Determines whether to stage all changes before the commit, in case the staging area (index) is empty |
gitSemanticCommit.types |
Specifies the supported message types |
Customize Your Types
Besides the fact you can add new message types, it's also possible to modify the existing values and their descriptions:
Customize Your Scope
You can modify the scope template through a placeholder:
๐๐ป Contributing
This is an open source project. Any contribution would be greatly appreciated!