如何进行出色的代码审查？🤝

今天在@doctolib 我们举办了一个非常有趣的关于代码审查的研讨会：为什么它们很重要，如何确保它们做得很好，以及它们如何服务于团队和产品质量。

我觉得分享我学到的东西会很有趣！🤓

什么是代码审查？

完成某个功能的开发后，您可以push在分支上提交工作并发起拉取请求。另一位开发人员会审阅您的代码，并考虑是否可以将您的工作合并到主分支（或您指定的其他分支）。

代码审查的目标是什么？

• ✨提高代码质量和编码标准
• 🕷尽早发现错误：越早越好
• 🎓分享知识并向他人学习：无论您的资历如何，您都可以学到很多东西！

良好代码审查工作流程的示例

1 - 🛎 知道有一个拉取请求正在等待你

• 在 GitHub / GitLab 上设置通知
• 检查您的项目管理委员会（Jira、Trello、Asana……）

💻 作为 PR 创建者：

• 在 Github 上标记审阅者以确保他们收到通知
• 或者直接在 Slack 或任何你使用的工具上ping他们

2 - ⏳ 花时间：安排代码审查

• 当您被分配要审查的 PR 时，请设置专门的时间来集中精力
• 或者你甚至可以在日历中设置重复的专用时间

💻 作为 PR 创建者：

• 不要犹豫，向审阅者建议一个时间段，这样你们就可以一起检查代码

3 - 💡 了解任务

• 检查用户故事或错误报告：充分了解功能或修复的背景和预期行为
• 询问了解情况的人：编写代码的开发人员或负责的产品所有者
• 阅读测试：它们也是了解预期行为的好方法

💻 作为 PR 创建者：

• 请随意添加该功能的屏幕截图/动图，以便审阅者更容易了解正在发生的事情

4 - 🕷 查找错误：要寻找什么？

• 确保涵盖整个故事：检查测试和实施是否涵盖了你能想到的边缘情况
• 性能问题：检查性能以确保没有任何性能下降
• 约定：确保命名、语法等符合定义的标准
• 代码质量/清晰度：检查代码是否易于阅读和理解，以及是否可以重构
• UI 设计：确保更改符合线框和用户体验
• 安全性：确认您没有看到 PR 引入的安全漏洞

💻 作为 PR 创建者：

• 你有责任尽可能多地进行测试，并且只在你认为有必要的时候才申请 PR

5 - 🤝 提供反馈

• 书面交流更加困难：记住，文字很容易被误解，所以不要犹豫，要强调好的方面，并明智地选择你的措辞
• 提出开放式问题：确保您理解代码和决策
• 有同理心：确保你以积极的方式提出建议，并且如果事情需要修改，也不会感到沮丧
• 首先关注最重要的事情：如果你还发现严重的错误或安全漏洞，就不要花太多时间讨论小的语法错误
• 必要时请求更改

💻 作为 PR 创建者：

• 请记住，受到批评的是你的代码……而不是你！

6 - 🎉 批准拉取请求！

什么时候应该批准拉取请求？

• 当该功能完成其应做的工作时
• 当你觉得维护代码很轻松时
• 当你觉得调试代码很轻松时

这个很棒的研讨会是由Emmanuel Gautier举办的，谢谢！👏

如果你有其他关于代码审查的好做法、技巧或工具，我很乐意听听！🙌