CodeReview 中常见缩写

  • ASAP: As Soon As Possible. 请尽快完成
  • ACK: Acknowledgement. 承认,同意。表示接受代码的改动
  • CR: Code Review. 请求代码审查
  • CCN: Code Comments Needed.需要的代码注释:在这里有一些简短的注释在高层次上描述每个主要代码块的作用(例如,“处理 HTTP 请求中的标头”)会很有帮助
  • DOODOO: Documentation Out Of Date Or Obsolete.文档过时或过时:此文档似乎不正确:是否过时?
  • DNM: Do not merge. 不要合并
  • ditto: 多个重复的表述,下一次可以用 ditto 表示同上
  • IMO: In My Opinion 在我看来、依我看、依我所见
  • LGT1: Looks Good To 1. 如果有一个回复 LGTM 则可以添加为 LGT1,1 代表目前有 1 个赞
  • LGT2: Looks Good To 2. 如果有两个回复 LGTM 则可以添加为 LGT2,2 代表目前有 2 个赞
  • LGTM: Looks Good To Me. 代码已经过 review,可以合并
  • MCE: Must Check for Errors.必须检查错误:这里可能会发生错误或异常情况,但您没有任何代码来处理此类事件
  • MR:merge request. 合并请求
  • NACK/NAK: Negative acknowledgement. 不同意,不接受这次的改动
  • IMHO: In My Humble Opinion IMO 谦虚的说法
  • IMO: In My Opinion. 在我看来
  • IIRC: If I Recall Correctly. 如果我没有记错的话
  • PR:Pull Request. 拉取请求,给其他项目提交代码
  • PTAL: Please Take A Look. 提示项目 Owner/contributor review
  • RFC: Request For Comment. 请求进行讨论,表示认为某个想法很好,邀请大家一起讨论一下
  • RCP: Repeated Code Pattern.重复代码模式:与上面几行非常相似的代码在许多不同的地方重复出现。找到一种方法来简化它(例如,定义一个隐藏细节的更高级别的 API,或者找到一个更集中的地方来执行这些操作,这样这里就不需要这段代码了)。
  • SGTM: Sounds Good To Me. 和上面那句意思差不多,也是已经通过了 review 的意思
  • TBD: To Be Done. 未完成,待续
  • TL;DR: Too Long; Don’t Read. PR 内容太多,没办法看
  • TMLI: Too Many Levels of Indentation.Too Many Levels of Indentation:缩进太深的代码很难阅读。在大多数情况下,可以重构代码以减少嵌套级别。
  • WIP: Work In Progress. 告诉项目维护者这个功能还未完成,方便维护者 review 已提交的代码
  • TBR: To Be Reviewed. 提示维护者进行 review
  • TBD: To Be Done (or Defined/Discussed/Decided/Determined). 根据语境不同意义有所区别,但一般都是还没搞定的意思