前言:
今天朋友们对“ideagit提交”大约比较关心,你们都想要了解一些“ideagit提交”的相关内容。那么小编也在网上网罗了一些对于“ideagit提交””的相关文章,希望看官们能喜欢,姐妹们一起来学习一下吧!想要通过模板写出更好的提交消息吗?本文将展示如何通过配置git,来获得更好的效果写出代码提交消息。
作者 | Fernando B
译者 | 弯月,责编 | 刘静
出品 | CSDN(ID:CSDNnews)
以下为译文:
最近在推特上看到了如下推文,我感觉好像挨了当头一棒。由于我的大部分项目都只有我一个人,所以我总是只写一行注释,比如init、update、readme、fix-01等等。在本文中,我将向你展示如何通过配置git,在vscode上利用模板写出更好的提交消息。
模板
如下是我当前使用的模板,当然你可以根据自己的喜好任意修改。点击这里获取我使用这个模板的一个例子()。刚开始的时候,你确实会发愁应该写些什么,但经过几次提交操作后,你就可以熟练掌握。
# 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:
检查默认文本编辑器
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()。
如何使用模板
在完成提交后,vscode会打开模板,你可以取消模板中的注释行,也可以添加新行。然后保存,并关闭文件。这时提交就算正式完成了。如果你不改动任何内容就关闭模板,则提交会被取消。在你执行完PR后,完整的提交消息会出现在PR中,供维护人员查看。
git commit
你喜欢哪种方式?
你喜欢只写一行注释,然后在PR中写详细的消息吗?
你喜欢使用提交模板吗?
你们团队/公司是否会强制使用模板?
还有其他方法吗?
希望您喜欢这篇文章,感谢您的阅读!
原文:
本文为 CSDN 翻译,转载请注明来源出处。
【END】
CSDN 博客诚邀入驻啦!
本着共享、协作、开源、技术之路我们共同进步的准则,
只要你技术够干货,内容够扎实,分享够积极,
欢迎加入 CSDN 大家庭!
扫描下方二维码,即刻加入吧!
标签: #ideagit提交