撰写好的 CL 描述
第一行(PR 的 title)
Body 内容翔实
糟糕的 CL 描述
优秀的 CL 描述
这里有一些优秀描述的例子。
功能性更改
前面几个词描述了这个 CL 到底做了什么。描述的剩余部分表明了解决的什么问题,为什么这是个好的解决方法,以及关于具体实现的更多细节信息。
重构
第一行描述了这个 CL 做了什么,以及这与过去的变化。描述的剩余部分讨论了具体的实现,CL 的上下文,该方案并不理想,以及未来可能的解决方向。它还解释了为什么要做这些更改。
需要一些上下文的小型 CL
第一句描述了具体做了什么。剩余部分解释了为什么要这样更改,并给了 reviewer 很多的上下文。