如何在git commit编辑器模式下将Issue标识放在提交消息开头?
解决Git编辑器提交消息开头#Issue标识被忽略的问题
没问题,我来帮你搞定这个麻烦!Git默认会把以#开头的行当作注释,提交时自动剔除,这才是你在编辑器里写#10 我的消息后该行消失的核心原因——和编辑器本身关系不大,是Git的提交消息处理逻辑在起作用。
给你两种实用的解决方案:
方法1:修改Git的注释字符配置
你可以把Git默认的注释字符从#换成其他符号(比如!、//),这样#开头的行就会被当作正常提交消息保留下来。
全局生效(所有仓库通用):
在终端执行这条命令:git config --global core.commentChar "!"之后你在编辑器里写提交消息时,
#10 我的消息会被完整保留;如果需要写注释(提交时会被忽略的内容),就用!开头的行,比如:#10 我的消息 ! 这是一条注释,提交后不会出现在提交记录里仅当前仓库生效:
进入目标仓库的目录,运行不带--global的命令即可:git config core.commentChar "!"临时生效(仅本次提交):
要是不想改动长期配置,只想这次提交保留#开头的消息,可以在提交时临时指定注释字符:git commit --commentChar="!"打开编辑器后正常写
#10 我的消息,提交后内容就会被正确保存。
方法2:适配平台的Issue引用格式(无需改配置)
如果不想调整Git配置,你可以看看项目使用的Git托管平台是否支持替代的Issue引用格式。例如:
- GitHub支持
GH-10代替#10 - GitLab支持
ISSUE-10这类格式
不过这个方法的前提是项目接受这种替代格式,如果必须用#10开头,那方法1是更稳妥的选择。
另外补充一点:如果用的是Vim这类编辑器,修改注释字符后,编辑器可能还是会把#高亮成注释样式,但这只是显示问题,完全不影响Git提交后的消息内容,不用在意~
内容的提问来源于stack exchange,提问作者Lucas Andrade
相关产品推荐
相关产品推荐

