更好的提交信息

更好的提交信息

浏览我的时间线时看到了下面这条推文，感觉有点被冒犯了。我的大部分项目都是单枪匹马完成的，所以我通常只写几行代码，比如 init、update、readme、fix-01 等等。在本文中，我将向你展示如何配置 Git，以便在 VS Code 中启动你的模板，从而获得更清晰的提交信息。

模板

这是我目前使用的模板，你可以根据自己的喜好进行修改。这里有一个我使用它的例子。一开始可能会让你思考该写些什么，但提交几次之后你就会掌握要领了。

# Commit Title (50 chars)

# Why? Issue, enhancement, etc.

# How does it address the why?

# Tickets, Links, etc...

将模板保存到您的主目录中

我给我的模板起了个名字.git_commit_msg.txt，但你可以随意命名。如果没有设置环境变量 HOME，那就使用绝对路径。

Linux、Mac

${HOME}/.git_commit_msg.txt

视窗

%HOME%/.git_commit_msg.txt

在 Git 上激活模板

Linux、Mac

git config --global commit.template ${HOME}/.git_commit_msg.txt

视窗

git config --global commit.template %HOME%/.git_commit_msg.txt

配置编辑器

核心编辑器文档

检查您的默认文本编辑器：

git config core.editor

我使用 VS Code 在 Git 配置中进行了配置：

git config --global core.editor "code -w"

代码需要添加到系统路径中。如果您code在终端/命令提示符中输入命令后编辑器没有打开，请打开 VS Code，然后按 CMD/CTRL+SHIFT+P，再输入命令shell command，您应该会看到安装和卸载选项。Windows 默认会在安装过程中添加代码。

代码可以用你喜欢的文本编辑器（vim、emacs、sublime）替换；如果你的文本编辑器有问题，SO是你的好帮手。

它是如何运作的？

提交后，模板会在 VS Code 中打开，您可以取消注释模板中的行，添加新的行等等。保存消息并关闭文件。此时，您的提交就完成了。如果您在未添加任何内容的情况下关闭模板，提交将被取消。当您创建 PR 时，完整的提交消息将包含在您的 PR 中，供维护者审核。

git commit

你仍然可以使用-m参数来处理那些烦人的一行代码。

你更喜欢哪种？

• 你喜欢用简洁的语言概括，然后再写详细的公关稿吗？
• 你们使用提交模板吗？
• 你们团队/公司是否强制使用模板？
• 还有其他方法吗？

希望您喜欢这篇文章，感谢阅读！