在 GitHub 上玩转开源项目的 Code Review

本文分享了在GitHub上进行Code Review的全过程,包括如何认领和开始Review任务,使用GitHub网页版和本地IDE进行审查,以及何时适当地修改别人的PR。文章探讨了Code Review的目的,规范和不同层次的要求,旨在提升团队协作和代码质量。
摘要由CSDN通过智能技术生成

一、幕后故事

时光荏苒,岁月如梭…… (🤮太文绉绉了,这不是我的风格)

今天我准备聊聊在 GitHub 上如何玩 Code Review。

突发奇想?心血来潮?不是。

咋回事呢?(对八卦不感兴趣的可以直接跳到下一节,但是我猜你会感兴趣。)


首先我是 DevStream 开源社区成员。

在五月份,又有3位活跃的优秀的牛X的 Contributors 正式加入 DevStream 开源社区,正式成为了社区 Member!

(看下面的红框框)
请添加图片描述
于是乎,加上三月份的4个“老 Member”,DevStream 社区就有7个“社区 Member”了(社区 Member 区分于像我这种在思码逸上班的内部 Member)!

7个疯狂输出的 Members,外加接近20个 Contributors,我和铁心两个人基本就只能看着 pr 笑笑,一边表示欣喜,一边表示 review 不过来了,“应接不暇”,废了废了……

也就是说,是时候组织一个 reviewer 组,拉着大家一起玩 Code Review 流程了!

说到 Code Review 流程,流程是啥?规范是啥?规则是啥?技巧是啥?xxxx?我能预想到 reviewers team 这个事情落地之日会有一堆问题砸到我头上。好吧,我需要写一篇文章来聊聊这些事。

二、踏上旅途

下面我们开始一次 Code Review 之旅。

1. 抢票阶段:认领一个 Review 任务

开始一次 review 之前,首先咱得“认领”一个 review 任务。

怎样算成功认领?如下图,Reviewers 里有你的头像,这时当前 pr 你就是 reviewers 之一,同时可以看到黄色 bar 里的一行字“This pull request is waiting on your review.”以及绿色的按钮“Add your review”。你可以点击这个“Add your review”开始一次 Code Review 之旅。

请添加图片描述

那么怎么认领呢?” 可能你还想问我。

这个问题有答案,也没有答案。

因为你是 reviewer 之一,那么你就有权限自己点击 Reviewers 右边的⚙️齿轮按钮,然后指定自己是一个 Reviewer。如果你不是一个“合法”的 reviewer,那么你得先成为 reviewer (If you want)。

2. 持票上船:开始 Review 流程

点击 Add your review 按钮后,咱就进入到了网页版 Code Review 页面,大致如下:

请添加图片描述

这里有很多值得“探索”的特性,比如:左边的“文件树”、文件树上方过滤“commits”的下拉框、右边的“文件过滤”、每个

  • 11
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
参与开发 GitHub 上的开源项目通常分为以下几个步骤: 1. 寻找感兴趣的项目:在 GitHub 上搜索或使用一些辅助工具(如 GitHub 官方推荐的 Explore、Awesome 等)来寻找自己感兴趣的开源项目。 2. 了解项目:了解项目的目标、功能、代码结构、文档等,可以阅读项目的 README、Wiki、Issues 等来获取更多信息。 3. 提交 Issue:如果在使用项目中遇到了问题,可以提交 Issue 来反馈问题。在提交 Issue 时,要尽可能详细地描述问题,包括复现步骤、期望结果、实际结果等。 4. Fork 项目:在 GitHub 上 Fork 项目的代码仓库,这样就可以在自己的账户下拥有一份完整的项目代码。 5. Clone 代码:在 Fork 的项目中,通过 git clone 命令将代码克隆到本地。 6. 创建分支:在本地代码的基础上,创建一个新的分支,用于开发自己的功能或修复问题。 7. 编写代码:在新的分支上,编写代码实现自己的功能或修复问题。 8. 提交 Pull Request:在开发完成后,在 GitHub 上提交 Pull Request 来请求合并自己的代码到项目的主分支。 9. Code Review:项目维护者会对提交的代码进行 Review,包括代码质量、风格、文档等方面。 10. 审核通过:如果 Code Review 通过,项目维护者会将代码合并到主分支中。 参与开源项目需要耐心和技术能力,还需要与项目维护者进行良好的沟通和合作。参与开源项目可以提高自己的技术水平,也可以为开源社区做出贡献。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值