程序员如何通过 Git 来更好地提交消息？

想要通过模板写出更好的提交消息吗？本文将展示如何通过配置git，来获得更好的效果写出代码提交消息。

作者 | Fernando B

译者 | 弯月，责编 | 刘静

出品 | CSDN（ID：CSDNnews）

以下为译文：

最近在推特上看到了如下推文，我感觉好像挨了当头一棒。由于我的大部分项目都只有我一个人，所以我总是只写一行注释，比如init、update、readme、fix-01等等。在本文中，我将向你展示如何通过配置git，在vscode上利用模板写出更好的提交消息。

模板

如下是我当前使用的模板，当然你可以根据自己的喜好任意修改。点击这里获取我使用这个模板的一个例子（https://github.com/dmroeder/pylogix/pull/71）。刚开始的时候，你确实会发愁应该写些什么，但经过几次提交操作后，你就可以熟练掌握。

# 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

Windows

%HOME%/.git_commit_msg.txt

在Git上激活模板

Linux，Mac

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

Windows

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

配置编辑器

core.editor docs：

https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreeditor

检查默认文本编辑器

git config core.editor

我利用如下命令，将git的默认文本编辑器设置成vscode：

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

你必须将code加入到环境变量的路径中，如果你在终端/提示符下输入code，却未能打开编辑器，那么请打开vscode并执行CMD/CTRL+SHIFT+P，然后输入shell command，这时你应该能看到安装和卸载选项。Windows默认会在安装过程中添加code。

你可以将code换成你喜欢的文本编辑器，例如vim、emacs、sublime等。如果你的文本编辑器有问题，那么可以参考StackOverflow（https://stackoverflow.com/search?q=core.editor+git）。

如何使用模板

在完成提交后，vscode会打开模板，你可以取消模板中的注释行，也可以添加新行。然后保存，并关闭文件。这时提交就算正式完成了。如果你不改动任何内容就关闭模板，则提交会被取消。在你执行完PR后，完整的提交消息会出现在PR中，供维护人员查看。

git commit

你喜欢哪种方式？

你喜欢只写一行注释，然后在PR中写详细的消息吗？

你喜欢使用提交模板吗？

你们团队/公司是否会强制使用模板？

还有其他方法吗？

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

原文：https://dev.to/kodaman2/better-commit-messages-3dnm

本文为 CSDN 翻译，转载请注明来源出处。

【END】

Python学习,怎么入门?

https://edu.csdn.net/topic/python115?utm_source=csdn_bw

CSDN 博客诚邀入驻啦！

本着共享、协作、开源、技术之路我们共同进步的准则，

只要你技术够干货，内容够扎实，分享够积极，

欢迎加入 CSDN 大家庭！

扫描下方二维码，即刻加入吧！

热文 推荐

☞

点击阅读原文，输入关键词，即可搜索您想要的 CSDN 文章。

你点的每个“在看”，我都认真当成了喜欢

程序员如何通过 Git 来更好地提交消息？相关推荐

sis防屏蔽程序_程序员如何写一份更好的简历
01 引言面试前要准备的第一件事就是写简历,从零开始写简历是一件痛苦的事,因为它既重要又耗时.现在就有很多求职者在电脑前急躁不安地搜索简历模版和参考例句,却不知道如何下笔.写得太短的话HR一定觉得没 ...
非程序员如何使用 Git——版本控制你的生活
在协同工作和版本控制方面,Git 绝对是一个优秀的工具,但其优点并不被大众所熟知.在过去的几年中,由于大众对于文字处理,电子表格(译者注:这里暗指Word和Excel,下同.)以及其他常用的功能的需求 ...
程序员必备：Git入门，超详细
对于一个刚入行的程序员或者是大学生,我建议大家还是好好的把git学学,因为在现在大部分企业代码的管理工具都是使用Git,其实Git很简单,无非就是一些命令,我们平常多去用它,就能熟能生巧.我觉得你们可 ...
程序员如何写一份更好的简历
01 引言面试前要准备的第一件事就是写简历,从零开始写简历是一件痛苦的事,因为它既重要又耗时.现在就有很多求职者在电脑前急躁不安地搜索简历模版和参考例句,却不知道如何下笔.写得太短的话HR一定觉得没 ...
同样是Java程序员，如何比别人更优秀？
随着互联网时代的飞速发展,越来越多的人投身于软件开发行业,大家都称他们为程序员,或者码农. 这些程序员的水平也是参差不齐的,有些人从比较好的学校毕业,水平却一般般:也有些人从一般搬的学校毕业,但是水平 ...
程序员如何在百忙中更有效地利用时间，如何不走岔路，不白忙（忙得要有效率，要有收获）...
程序员忙,似乎是个公论,有些程序员甚至会认为,不忙的程序员无法快速地进步,从而会落伍.或者说,不忙的程序员有可能被公司末尾淘汰掉.对此,一直危机感很重的我深以为然. 因为,我见过不少得过且过的的程序员 ...
程序员应该如何做才能更好的实现自我价值？
有的人,大佬做久了,会想去做个程序员布道者,那么就好会在想作为程序员到底有哪些经验给后来者? 以下是自网友@情郎十二画的衣蛾分享: 1.不要迷信"大牛"."大佬" ...
程序员去哪个城市工作更好？我选择深圳的几个理由
程序员应该去哪个城市工作呢?这是许多人比较关心的问题.如果要在北方选择一个城市和南方选择一个城市,那么北方的话我首先会选择北京,南方的话则首先会选择深圳. 选择北京的理由是第一,许多公司的总部都设在北 ...
当程序员争论甜咸粽子哪个更好吃时……| 每日趣闻
@程序员,端午去哪儿玩呢?欢迎留言分享哦. 如果你有关于程序员的趣图,欢迎扫描下方二维码投稿哦! 往期趣闻 ☞超严格!大项目中程序员的时间分配-- | 每日趣闻 ☞程序员竟做了这件不可描述的 ...

程序员如何通过 Git 来更好地提交消息？

程序员如何通过 Git 来更好地提交消息？相关推荐

最新文章

热门文章