TEL:400-8793-956
当前位置:开发工具

Github上git commit提交注释的规范

提问者:网民 近期获赞:55 浏览人数:344 发布时间:2020-12-09 10:15:35

 问:例如,有这样的注释(重印)

通常,提交给GIT的注释可以分为几个类别,从几个动词开始:
 
添加
已修复(修复错误)
已变更
已更新(已完成任务,或由于第三方模块的更改而进行的更改)
尽量将评论简化为一句话,不要包含细节。
如果存在问题系统,则该系统可以包含问题的ID。例如:发行[456]
包含作者的信息。例如,通过Bruce
完成的示例:
git commit -m'问题#[问题号],[用户名]:[变更的简短摘要]。'
相关文章
标准注释方式如何?
 
答:个人习惯:
 
解决问题并写:fixed #XX
较小的改动用一句话就清楚了。
对于重大改革,我们应该建立一个问题,以澄清情况,计划和变更……。然后再加上1
此处的另一个优点是,提交日志#XXGitHub将显示为指向相应发行版的链接,并且在相应发行版中将显示引用该发行版的提交提示。
而且,它是相似的。fixed #XX这样,GitHub也将自动为您解决问题。
 
实际上,最重要的是,提交日志是供人类查看的,只要说清楚一点,就不必太死板,更不用说只为机器看东西了。
 
答:Mod: remove unused code表示修改
Add: a new module to have faster process(加)
Rem: deprecate unused modules这意味着删除
Ref: improved the implementation of module X代表工厂
一些学生想问:如果以上任何陈述中都没有陈述提交的内容,该怎么办?
同学,这意味着您的提交应该分为较小的部分
。当然,我最喜欢的提交消息是第一次提交。内容是First Blood
上一篇: Android如何捕获本地信号异常,如何在Activey中调用将通过c底部的反射结束的方法,然后重新打开Android应用程序?
下一篇: git如何从远程仓库删除错误提交?