Uber Go Style Guide
代码的commit遵循的原则:
最小化原则体现:
<issue> : <subject>
代码评审(Code Review)是指在功能开发过程中,邀请原作者之外的开发者(审阅人)来对功能代码 进行评审的步骤。其目的是为了在代码合并入主线之前确保其质量,避免对主线代码的质量造成负面的影响。
实际开发中,我们通常都是在各自开发分支进行开发,那么功能开发完成之后,或修复bug之后,就需要除了自己之外的其他人进行code review。从而提高代码的质量以及避免合并到主线上之后对主线代码造成影响。所以code review 最直接的目的就是:「代码长期的可用性与可维护性」
流程:
定方案-->写代码-->自测-->提 MR
MR所包含的内容:
关于commit历史:通常我们在开发过程中的commit历史是会比较糟糕的,可能也commit message 也会不规范,所以我们在提交mr之前就需要对我们的commit历史进行整理,如:
「注:对于没有任何描述的MR审阅人可以直接拒绝审阅」
「注:永远做自己MR的第一个审阅人」
当代码质量出现(不限于)以下情况时,可以认为完成度过低:
Effective Go
Go Code Review Comments
How to Write a Git Commit Message