HbCommitMessage - 101camp/playground GitHub Wiki

提交说明规约

~ 规范 push 时的单行表述

参考:Commit message 和 Change log 编写指南 - 阮一峰的网络日志

背景

1m[TASK]卡包内容迭代 · Issue #68 · OpenMindClub/OMOOC.Py.OC

先组织教练内部在仓库分支中高密度协同迭代课程 pack 的撰写

现象

  • 无论使用 git 还是 web 界面来提交变更时
  • 大家都对提交说明没有关注
  • 导致无论在 github 页面, 还是本地 git log 查询时,都无法快速明确哪个版本是需要的

方案

~ 暂行规约

提交说明消息格式:

    
    type (scope) TimeLog subject
      |    |        |    +- 简述: 目的/完成了什么, 全小写,不用句号,尽可能英文
      |    |        |
      |    |        +- 完成耗时, .5h 30min 这种形式
      |    |
      |    +- 范畴: 变更了什么, 可用 #issue id 来和对应任务绑定
      |    
      +- 类型: 说明结果性质 可以是
            +- debug ~ 调试
            +- fix ~ 修补bug
            +- doc:文档 (documentation)
            +- del:删除 (delete)
            +- try:实验
            +- feat ~ 新功能(feature)
            +- style: 格式(不影响代码运行的变动)
            +- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
            +- test:增加测试
            +- chore:构建过程或辅助工具的变动

CHANGELOG

  • 190522 damao repost
  • 170420 ZQ init.
⚠️ **GitHub.com Fallback** ⚠️