VSCODE插件推荐(Git-commit-plugin For Vscode)
插件地址
转载来源:
Git-commit-plugin For Vscode 一款自动生成规范git提交信息的插件
Git-commit-plugin For Vscode 一款自动生成规范git提交信息的插件
推荐理由
提供了符合规范的提交格式,基于Angular 团队的 Angular Team Commit Specification。规范的 commit 信息首先提供了更多的历史信息,方便快速浏览。其次,可以过滤某些 commit(比如文档改动),便于快速查找信息。重点在于前端团队必备的git提交规范啊!!!不规范的提交后期维护项目真的很头疼,给个不规范的例子
Angular 团队的 commit 规范
它的 message 格式如下:
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
分别对应 Commit message 的三个部分:Header,Body 和 Footer。
Header
Header 部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。
type: 用于说明 commit 的类型。一般有以下几种:
feat: 新增feature
fix: 修复bug
docs: 仅仅修改了文档,如readme.md
style: 仅仅是对格式进行修改,如逗号、缩进、空格等。不改变代码逻辑。
refactor: 代码重构,没有新增功能或修复bug
perf: 优化相关,如提升性能、用户体验等。
test: 测试用例,包括单元测试、集成测试。
chore: 改变构建流程、或者增加依赖库、工具等。
revert: 版本回滚
scope: 用于说明 commit 影响的范围,比如: views, component, utils, test…
subject: commit 目的的简短描述
Body
对本次 commit 修改内容的具体描述, 可以分为多行。如下:
body: 72-character wrapped. This should answer:
*Why was this change necessary?
*How does it address the problem?
*Are there any side effects?
initial commit
Footer
一些备注, 通常是 BREAKING CHANGE(当前代码与上一个版本不兼容) 或修复的 bug(关闭 Issue) 的链接。
使用方式
-
首先在 Vscode 插件市场搜索 git-commit-plugin 安装。
-
安装完之后可以使用组合键 Command + Shift + P 呼出 指令行,并键入指令 show git commit template 或者点击 git 插件栏上的小图标唤醒插件界面。
-
根据自己当前提交所要表达的意义,选择对应的 type 类型去编写 commit 信息