Commit message和code review那些事

commit message

小编在每次写完程序提交代码的时候,都会通过git上传,git commit -a 'message' 但是message到底写什么,很是伤脑;

后来整理出了一些commint message 作用共同学们参考:

  1. 提供更多的历史信息记录,方便快速浏览与查询
  2. 配合管道查询过滤查看某些commit内容和历史记录
  3. 能直接从commit生成Change log

网上也有很多规范格式,这里小编列出一些关键词,commit 分Header,Body ,Footer

Header:可以理解为title,紧要说明本次提交内容与信息,提交内容可以分为一下几大类

- feat: 开发新功能 (feature)
- fix: 修复bug
- docs: 文档 (documents)
- style: 格式 不影响代码运行逻辑
- refactor: 重构
- test: 测试添加
- chore: 构建过程或者辅助工具的变动

Body:可以理解为内容,就是对header的补充,此处内容在可视化的git上是省略号(...)表示

code review

小编最近也开始去review其他同学的代码了,会遇到很多无厘头的在评论区加上英文缩写,真是一脸懵。不过缩写总是有来头的,下面给出几种常见的缩写简称

  • PR: Pull Request.
  • LGTM: Looks Good To Me.
  • SGTM: Sounds Good To Me.
  • WIP: Work In Progress.
  • PTAL: Please take A look.
  • TBR: To Be Reviewed.
  • TL;DR: Too Long;Didn't Read.
  • TBD: To Be Done(or Defined/Discussed/Decided/Determined).
posted @ 2019-06-11 15:46  q兽兽  阅读(340)  评论(0编辑  收藏  举报