Skip to content

PR检视和合入Checklist

ajaxzheng edited this page Aug 14, 2024 · 6 revisions

为了保障组件质量和用户体验,Committer(代码检视者)应该认真审视每一个合入的PR,遵循一定的流程和规范,对于不符合规范的PR应该提出检视意见,逐步形成重视规范和质量的社区开发氛围。

因此我们梳理了以下PR检视的Checklist(持续完善中):

  • PR标题是否符合命名规范
  • PR标题中是否标记了修改的组件,以便触发对应组件的E2E测试用例。例如:feat(button): [button] 描述信息
  • PR描述中是否关联Issue单,以便PR合入之后自动关闭对应的Issue单
  • PR描述中的自检项是否勾选
  • PR是否勾选上对应合适的标签tag
  • 每个PR都用一个单独的分支,在提交PR的时候勾选PR合并后自动删除分支
  • 每个PR都需要写明修改了哪些问题,新增了哪些特性之类的,不要写和业务相关的字段
  • E2E测试用例是否全部通过
  • 新组件和组件新特性,是否有破坏性变更,是否补充相关 api 和 demo 文档,是否补充E2E测试用例
  • 新组件/新API是否标记版本信息
  • PR是否遵循单一职责原则,将影响面控制在单个组件中
  • 代码是否符合规范,通过ESLint检查
  • 如果是在当前工程中新建的分支,需要勾选在PR合入后删除该分支