代码交付checklist[初稿]

[wklken]

代码交付checklist[初稿]

提交 PR 前, 请检查一下checklist

• 提交 PR 的开发者是否签了 CLA
• 当前将要提 PR 的分支是否是从目标分支新切出来的(禁止复用原先提过 PR 的分支)
• PR 中只包含一个需求(禁止一个 PR 交付多个需求)
• 提交的 commit message 需要符合规范, 并且需要关联对应的issue (必须)
• [代码层面] 是否有新增文件, 新增文件头需要带本项目的开源license
• [代码层面] 新增/变更的代码逻辑有对应的单元测试 (必须)
• 确认 pre-commit 全部检查通过(本地开发环境配置了pre-commit: black/pep8/isort/mypy检查)
• 确认本地执行单元测试全部通过
• 确认在本地环境验证过, 并且验证通过(再小的变更也得验证, 避免类似语法错误等低级问题进入下一阶段)

提交 PR 后 checklist

• 提交后: 有冲突提示的需要修复
• 提交后: github action需要检查通过, 风格检查+单测, 有失败的需要修复
• 提交后: 腾讯内部的codecc扫描失败需要确认, 大概率是复杂度超过最大限制, 需要重构拆解函数
• 每次 Review 后的修复需要关闭对应的conversation, 如果有不处理的需要说明原因

合并 PR 的 checklist

• 必须有 2 个reviewer, 并且 Reviewer approve (github仓库配置规则)
• 合并前, 所有 conversation 都必须close (github仓库配置规则)
• 必须 使用squash and merge合并个人的 PR 到主仓库