GitHub Pull Requests (PR)提交指南-Pycharm版

GitHub Pull Requests (PR)提交指南-Pycharm版

若您对GitHub的Pull Requests(PR)操作流程感到陌生，我们非常建议您使用自己熟练的IDE来完成基础的PR操作。接下来的示例中我们将会演示如何向”TestPR”示例项目中PR一个简单”test.py”文件。

若不喜欢使用Pycharm进行PR，也可参考传统方式使用命令进行PR：https://blog.csdn.net/qq_44183661/article/details/114665784

Step 1 Fork目标项目

Step 2 获取GitHub项目链接

打开Fork后的GitHub项目页面并点击“Code”按钮，获取该Repo的Git地址。

Step 3 在Pycharm中Clone该项目

打开Pycharm，在屏幕顶端菜单栏的“VCS”选项卡中选择“Git from Virson Control”，待弹出对话框后向URL输入框中填写刚刚获取到的Git地址，确认地址无误后即可点击“Clone”按钮进行Clone。

Step 4 切换至新分支

点击右下角的分支管理按钮，新建一个方便记忆的分支名作为我们的开发分支。

Step 5 添加/修改代码

在大型项目中，对代码的增删是较为正常的贡献方式，但如果是想为目标项目贡献一个长期维护的组件，那么可能需要使用到“子模块”来提升提交效率。接下来将会介绍增删代码和贡献子模块两种贡献方式供大家选择。

1. 增删代码

Clone后即可得到目标项目的所有文件和结构，这里我们可以新建一个名为”test.py”的文件作为需要添加的代码进行PR。

Clone后的项目
新建”test.py”文件

选择是否在Git中添加代码

新增后的文件（红色：未加入，绿色：新加入，蓝色：被修改）

2.添加子模块

若目标项目中需要经常使用你贡献的模块，那么使用子模块功能将会大大提高开发效率，只需要我们将自己的项目以下方形式进行PR就可以完成子模块配置。如果您还没有创建自己的GitHub项目（Repository），那么在执行该步骤前需要新建一个Repository并上传自己的代码。

在Repository中复制其GitHub地址

在Pycharm的终端中输入”git submodule add 自己项目的地址 存放路径”

添加成功后，左侧文件夹将会出现我们的项目文件夹以及包含的文件

Step 6 安装pre-commit钩子

pre-commit工具来管理Git预提交钩子。它可以帮助我们格式化源代码Python，在提交（commit）前自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。pre-commit测试是 Travis-CI 中单元测试的一部分，不满足钩子的PR不能被提交到Paddle，首先安装并在当前目录运行它
打开Pycharm设置，进入下图的包管理器界面安装pre-commit。安装完毕后可在终端中执行pre-commit的部署操作。

Step 7 Commit代码

在Commit代码之前，我们需要确认原项目代码是否有变动，若其他开发者在原项目基础上提交了代码，那么我们需要先将其代码同步至本地然后再进行Commit操作。

配置远程仓库地址

添加原始项目仓库地址

更新分支列表

点击Pull拉取分支

拉取代码

该步骤中如果其他开发者和您的代码有冲突，可以对冲突进行选择，待同步结束后方可进行Commit。

Step 8 向自己仓库中Push代码

在上方菜单栏中选择 VCS->Git->Push进行Push操作。

Step 9 在GitHub上提交PR

回到刚刚Fork后的GitHub项目页面，点击出现的”Compare & pull request”按钮即可开始PR操作。

End

在提交PR后将会有Reviewers对提交的代码进行审阅，如需修改代码重新提交可从Step 5开始修改并完成后续步骤，这样即可在原PR请求基础上进行更新。