如何向开源项目提交PR(pull rquest)

466 阅读3分钟

如何向开源项目提交PR(pull rquest)

在开发开源项目时,我们经常需要向开源项目提交PR,本文将介绍如何向开源项目提交PR(pull rquest)。本文将以本人向 ant design 提交PR为例,讲清楚具体操作。

什么是 Pull Request?

Pull Request(PR)是 GitHub 上用于请求将代码合并到主分支的机制。

就是在 GitHub 上提交代码,然后向开源项目发起请求,让开源项目将代码合并到主分支。

步骤

在开源项目中提交PR(Pull Request)是一种常见的贡献方式,它允许开发者向项目仓库提交代码更改并请求合并到主分支中。以下是提交PR的一般步骤:

  • 1、 Fork仓库

首先,你需要Fork(即复制)你想要贡献的开源项目的仓库到你的个人GitHub账户下。这样,你就可以在自己的仓库中进行更改,而不会直接影响到原始仓库。

  • 2、 Clone代码

将Fork后的仓库Clone(克隆)到你的本地开发环境中。

  • 3、 创建分支

在本地开发环境中,创建一个新分支,用于存储你的更改。

  • 4、 修改代码

在新分支中,修改代码,添加新功能或修复bug。

  • 5、 提交更改

在本地开发环境中,提交更改到本地仓库。

  • 6、 推送更改

将更改推送到Fork后的仓库(自己的远程仓库)。

  • 7、 创建PR

在GitHub上,打开Fork后的仓库,然后点击"New Pull Request"按钮。然后,选择你的分支和目标分支(通常是主分支),并填写必要的信息,如PR标题和描述。

  • 8、 等待审核

提交PR后,其他贡献者将收到通知,并需要审核你的更改。他们可能会进行必要的修改或反馈。

  • 9、 合并PR

如果PR被接受,其他贡献者将收到通知,并需要合并你的更改。

示例

以下为例,以向 ant design 提交PR为例:

  • 1、 Fork仓库

20240605141138

  • 2、 Clone代码
git clone https://github.com/mySkey/ant-design.git
  • 3、 创建分支

修复 Anchor 锚点组件replace 方法导致滚动动画失效的bug

git checkout -b fix/5.17.3-anchor-replace
  • 4、 修改代码
*************
  • 5、 提交更改
git add .
git commit -m "fix: anchor-replace"
  • 6、 推送更改
git push --set-upstream origin fix/5.17.3-anchor-replace
  • 7、 创建PR

可以在ant design仓库创建PR请求

20240605142100

或者在ant design仓库首页 / 自己的远程仓库直接创建PR请求

20240605142501

20240605142317

  • 8、 等待审核

20240605142604

  • 9、 合并PR

通过审核后,PR将合并到主分支。即 ant design仓库的master分支将包含你的更改。

等待发布

  • ant design会每周末统一发布NPM包

等待发布后,即可使用新的版本。只需要升级npm包的版本号就行,然后去 ant design 更新日志查看自己的PR。

  • 已经到了ant design的更新日志中了

20240605142942

  • 使用
npm i antd@5.18.0

这个版本,就包含了修复内容。