拉取请求审查指南
编辑拉取请求审查指南
编辑对 Beats 的每一次更改都必须遵守高标准,虽然拉取请求的质量最终责任在于作者,但 Beats 团队成员有责任在审查过程中进行验证。如果本文档不清楚或不适用,则应以常识和共识为准。
代码风格
编辑每个人对风格都有自己的看法。为了避免在这个问题上花费时间,我们几乎完全依赖 go fmt
和 hound 来规范风格。如果这两个工具都没有报错,那么代码几乎肯定没问题。可能会有例外情况,但应该非常罕见。只有在最特殊的情况下才能覆盖这些工具的判断。
不稳定的测试
编辑随着软件项目的增长,其测试用例的复杂性也会增加,随之而来的是一些测试变得不稳定的概率也会增加。处理不稳定测试是每个人的责任。如果您注意到拉取请求构建失败的原因与推送的代码无关,请按照以下步骤操作:
- 使用“不稳定测试”github issue 模板创建一个 issue,并附加“不稳定测试”标签。
- 创建一个 PR 来静默或修复不稳定的测试。
- 合并该 PR,并在继续进行原始 PR 的正常 PR 流程之前,基于它进行变基。