Github上git commit 提交注释的规范
ringa_lee
ringa_lee 2017-04-24 09:13:41
[Git讨论组]

例如注释有这样的(转载)

一般情况下,提交 GIT 时的注释可以分成几类,可以用几个动词开始:

  • Added ( 新加入的需求 )
  • Fixed ( 修复 bug )
  • Changed ( 完成的任务 )
  • Updated ( 完成的任务,或者由于第三方模块变化而做的变化 )

尽量将注释缩减为一句话,不要包含详细的内容。
假如有 Issues 系统,其中可以包含 Issue 的 ID。比如:Issue #123456
包含作者的信息。比如 by Bruce
完整例子:
git commit -m 'Issue #[issue number] by [username]: [Short summary of the change].'
Related articles

大家的注释方式规范如何?

ringa_lee
ringa_lee

ringa_lee

全部回复(2)
大家讲道理
  • Mod: remove unused code, 表示修改(Modify)
  • Add: a new module to have faster process, 表示新增(Add)
  • Rem: deprecate unused modules, 表示移除(Remove)
  • Ref: improved the implementation of module X, 表示重构(Refactory)

有同学要问了:如果一个commit里的内容无法用上述任意一种语句陈述,应该怎么办?
同学,那说明你的commit应该被拆分成多个小部分

当然我最喜欢的commit message还是第一个commit,内容是 First Blood

伊谢尔伦

推荐这篇文章 写好你的 Commit Message

热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号