Skip to content

Atomeocean GitHub Pull Request 合并规范

合并前准备

必要条件

  • PR 已通过 CI/CD 流水线检查
  • 至少获得 1位核心维护者的批准
  • 所有代码审查意见已处理完成
  • 确保分支无冲突(需与目标分支保持同步)

PR标准合并流程

1. 选择合并方式

1. 在 GitHub PR 页面点击 **Merge pull request** 下拉框
2. 选择 **Squash and merge** 选项
3. 确认合并按钮变为 **Squash and merge**

2. 提交信息规范

text
- **标题格式**:`类型(模块): 简明描述`  
  示例:`feat(auth): 增加微信扫码登录功能`
  
- **正文内容**:
  - 功能变更说明(中英文双语)
  - 关联的 issue 编号(格式:`Close #123`)

3. 分支清理

bash
# 本地执行分支清理
git checkout main
git pull origin main
git branch -D feature/your-branch-name

4. 合并后操作

确认PR页面中表示状态的按钮从绿色的Open变为Closed,表示合并成功。

  1. 删除合并的分支
  2. (可选)更新项目合作pr记录请查看pr记录标准流程

最佳实践指南

提交规范

  • 单功能原则:每个PR只实现一个独立功能
  • 原子提交:拆分逻辑独立的代码变更
  • 文档同步:同步更新README/CHANGELOG
  • 版本标注:对破坏性变更添加版本提示(Optional)

代码质量

  • 严格遵循项目代码规范
  • 核心逻辑需添加代码注释