Git 提交代码时书写多行日志（配置Git commit template)

最新推荐文章于 2024-07-15 17:07:12 发布

Beyonderwei

最新推荐文章于 2024-07-15 17:07:12 发布

阅读量2.8k

点赞数 1

分类专栏： Git 文章标签： Git commit 模板提交多行日志

本文为博主原创文章，未经博主允许不得转载。

本文链接：https://blog.csdn.net/CSDN_X_W/article/details/96475796

版权

Git 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

文章目录

一、应用场景

通常我们会采用git commit -m “提交日志” 的方式去提交代码，但是如果我们程序更改的地方很多，那就需要写更多的日志来记录，当我们查看log以后是下面这个样子：（当然也可以在github上去点击查看效果）

这样的提交日志就相对来说很清除，下面就来记录一下实现提交多行日志的方式。

二、配置 Git 提交模板

在仓库的根目录下新建一个模板文件：如：git_commit_template.txt
git config commit.template git_commit_template.txt #注意这里文件要加后缀名，该方式设置的是当前分支的提交模板
git config --global commit.template git_commit_template.txt #设置的是全局的提交模板。
git config --global core.editor vim #设置模板的文本编辑器为vim,当然就需要我们在编写日志时会用简单的vim命令。
git commit #当我们再次提交时直接执行git commit 命令时会进入下图所示的模板界面，我们就可以“任意”书写多行的提交日志了。
日志模板中会提示当前所处的分支和修改过的文件可以很方便我们去写提交日志。强烈建议使用Git Bash 因为windows的命令行下不支持中文的输入，同时命令行对于高亮的支持也不好。

三、日志模板书写格式

当然我们可以写多行提交日志也不是随便的写，是有一些通用的格式的，下面部分从网上复制过来的常用的格式可以参考。
1. 常用格式：

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

2. 参数要求

<type>
feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style： 格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

<body>
Body 部分是对本次 commit 的详细描述，可以分成多行

<footer>
可以根据自己的需要书写。如影响范围等。