Pull Request 审核指南
Pull Request(PR)审核是保证代码质量、促进知识共享的重要环节。本指南涵盖从发起审核请求到完成合并的全流程规范,适用于所有Atomeocean贡献者。
发起审核请求
简洁版:适用于1行或简单的pr,如typo fix。
text
麻烦帮我看下这个 PR~[PR 链接]
带说明版:添加一下功能简述
text
我提了个 PR,主要是关于[功能简述],麻烦有空帮我看下~[PR 链接]
多人提醒版:适合发到discord群聊
text
各位有空帮我review 一下这个 PR 🙏:[PR 链接]
如果你是在Discord平台发,也可以加emoji做高亮,例如:
text
👀 麻烦大家帮忙review一下这个 PR:[PR 链接]
轻量工作组消息提醒
由于轻量工作组有每周活跃度的刚需,提醒PR审核时需要按照以下流程
指定责任人 在PR中明确指派组员作为审核人(assignee),确保责任到人。
PR评论模板
在PR评论区添加以下标准化提醒(英文):
texthello for light weight team member activity requirement, please review this PR as soon as possible, thanks! @指定组员
Discord 频道通知 在Discord
job-compass-discussion
频道同步发送以下提醒(中文):
text
【轻量工作组】请及时审核以下PR以满足活跃度要求:
PR链接: [链接]
感谢配合!
@[成员名]
PR标注
标签为good first issue
适合刚接触atomeocean时或活跃度较低时优先查看。
收到PR Review 邀请后
- 点击链接进入 PR 页面,了解整体变更的背景与目标。
- 逐一查阅所有变更文件,细致审查代码修改的细节与实现逻辑。
- 切换至 “Files changed” 选项卡,以直观比较代码前后差异。
- 点击 “Review changes” 按钮,选择 “Comment”、“Approve” 或 “Request changes”,并附上具体反馈。
视频教程
25秒看懂Pull Request Review
点击下方任意平台链接观看教学视频:
🎬 观看视频:
PR评论内容
在PR评论区,你可以使用以下模板进行审核:
look good to me的简写
text
lgtm
或提醒队友
text
请补充pr描述部分
仍有疑问?
如你在操作过程中遇到问题,欢迎在Discord中进入 #job-compass-discussion
频道提问,团队成员会协助你完成审核流程。