开源项目起步指南
1. 代码审查公开化
代码审查应公开进行。即便与其他开发者共处一室,有人提交代码时,也不应在室内口头审查,而要将审查内容发送到合适的在线审查论坛。公开审查能让每个人受益,大家可跟进评论,有时还能发现其中的缺陷;即便未发现问题,也能让大家意识到审查是常规活动,就像洗碗或修剪草坪一样。
要有效进行逐变更审查,需要一些技术基础设施。设置提交通知尤为有用,每次有人向中央仓库提交变更时,会发出包含日志消息和差异的电子邮件或其他可订阅通知(若差异过大则除外)。审查可在邮件列表或Gerrit、GitHub“拉取请求”界面等审查工具中进行。
以下是一个代码审查的示例场景:
| 步骤 | 操作 |
| ---- | ---- |
| 1 | 开发者提交代码变更到中央仓库 |
| 2 | 系统自动发出提交通知,包含日志消息和差异 |
| 3 | 审查人员在在线审查论坛查看通知并进行审查 |
| 4 | 审查人员提出意见和建议 |
| 5 | 开发者根据审查意见修改代码 |
下面是一个mermaid流程图展示代码审查流程:
graph LR
A[开发者提交代码变更] --> B[系统发出提交通知]
B --> C[审查人员查看通知并审查]
C --> D[审查人员提出意见]
D --> E[开发者修改代码]
2. 从第一个提交开始审查
应从第一个提交就开始审查。通过审查差异最易发现的问题包括安全漏
超级会员免费看
订阅专栏 解锁全文
616

被折叠的 条评论
为什么被折叠?



