Skip to content

doc: 网关协作开发交付规范 #57

@wklken

Description

@wklken

develop & self-testing

  • 每个开发都要有一套完整的开发环境
  • 修改helm charts之后, 必须dry-run确认, 并且在开发环境部署验证, 避免低级错误, 避免在后面的环节才发现问题返工
  • 各自功能提 PR 前, 必须做好自测(可以构建dev镜像顶掉目标pod, 验证完整逻辑), 避免低级问题出现
  • 重要: commit message必须符合规范, 清晰, 关联对应的issue; 会直接用于生成 release log

PR

  • 需要填写 PR 对应的变更点, 以便让reviewer更好理解和处理, 方便后续追溯
  • 涉及功能修改的 PR 必须包含单元测试
  • PR 的所有检查及单元测试必须通过
  • PR 的代码风格检查必须通过

Code review

  • 一个 PR 需要两个 reviewer approved
  • 所有conversation必须resolved
  • conversation 点 resolve的时候, 必须填评论, 已修改可以填done, 不修改需要给到理由 => 不要直接点resolve (这样可能有的问题就沉掉了)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions