如何在VSCode中使用标准模板编写Git Commit提交信息?
在VSCode中使用Git Commit标准模板的操作说明
当你在VSCode里执行git commit命令后,系统会自动打开一个编辑器,里面会显示预设的提交信息模板,内容大概是这样的:
<用于填写提交信息的空白行>
请输入您的变更提交信息。以'#'开头的行将被忽略,空提交信息会终止提交。当前分支:mybranch您的分支与'origin/mybranch'保持同步。待提交的变更:new file: README.mddeleted: README.rstmodified: foo.txt未跟踪的文件:bar.txt
咱们平时做提交的时候,有个很常见的规范写法,能让提交信息清晰易懂,方便团队协作和后续排查问题:
- 第一行写简短的提交摘要(尽量控制在50字符以内),比如
feat: 新增Markdown格式的README文档,用关键词明确变更类型(feat是新功能,fix是修复bug,docs是文档变更等) - 空一行之后写详细的变更描述,可以说说为什么做这个变更、具体改了什么、有没有影响其他功能,比如
替换原有的README.rst文件,适配项目的Markdown文档规范,提升可读性 - 如果有需要,最后可以加上关联的任务或Issue编号,比如
Fixes #456
另外再提几个模板里的小细节:
- 所有以
#开头的行都是注释,Git会自动忽略这些内容,不用特意删除它们 - 如果直接保存空的提交信息,Git会终止这次提交操作
- 模板里会自动显示当前分支状态、待提交文件和未跟踪文件,提交前可以快速核对变更内容,避免漏提或错提
内容的提问来源于stack exchange,提问作者Dror
相关产品推荐
相关产品推荐

