不会提交 PR 的小伙伴看过来，超详细的视频教程！

点击上方蓝字关注我们

作者 | 严天奇

✎ 编者按

最近有一些新加入社区的朋友反馈不太了解 Apache DolphinScheduler 提交 PR 的步骤和规则。这不，人帅心美的严天奇同学就录制了详细的视频教程，手把手教你提交 PR，不会的小伙伴快上车！

视频教程

大家好，这一期将会向大家介绍如何提交PR。

什么是 PR

我们在 Wikipedia 中搜索 pull request，页面直接进入了 Distributed version control 词条中。Pull request 是属于 Distributed version control system 的一个操作，wiki 中介绍到 PR 是为开源仓库做贡献的方式，也可以被称作 merge request。贡献者 request 开源项目维护人员来 pull 贡献者提交的代码改动，所以这个动作被称作 pull request。当贡献的代码改动被通过后，维护人员会merge 贡献者的改动到开源项目中。

我们可以从哪些方面提交 PR

绝大多数的代码贡献出发点来自 Apache DolphinScheduler，GitHub 的 issue中，其中会包含 Feature，Bug，Improvement，Test 和 Sub-Task 方向的改动。我们可以根据问题的描述，解决 issue 并进行代码贡献。

作为新手，我建议大家从新手任务开始。

打开 issue，我们可以看到 pinned issues 里的 good first contributor，官方持续为我们提供了入坑的新手任务，一般新手任务会带有 easy to fix 或 good first issue 标签。

我们可以从列表中选择自己感兴趣的问题，作为第一个 PR 的提交内容。

提交 PR 需要注意的点

我们打开官方文档中提交者指南里的 Pull Request 须知。

DolphinScheduler 对 PR 的规范，包括了 PR 标题，PR 分支名，Commit Message 规范，以及 Code Style 配置。

下面我们根据官方文档来学习正确的 PR 规范。

首先是 PR 标题。PR 标题是我们提交 PR 时设置的标题，由[PR 类型-ISSUE 号][模块名]和描述组成，模块名填对应的模块即可。

其次是 PR 分支名是我们在本地 clone 的项目中新建新的 PR 分支。格式是 Pull Request 类型 -Issue 号。

Commit Message 是我们在提交代码时的提交信息，应该包括三个部分：Header，Body 和 Footer。其中，Header 是必需的，Body 和 Footer 可以省略。

Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和 subject（必需）。

格式为[DS-ISSUE 编号][type] 和 subject。

其他 body footer 部分这里就不赘述，大家可以在 Commit Message 须知进行了解。

稍后我们就按照这个例子来写 Commit Message。

Code-style 按照官方进行配置即可，这样可以保证编码的格式，就不赘述了。

最后，DolphinScheduler 官方建议大家尽量把一个 Pull Request 作为任务的最小粒度进行提交。

Type 用于说明 commit 的类别，是类别的缩写，包括feat for feature，fix，docs，style，refactor，test，chore。

Scope 用于说明 commit 影响的范围，比如 Server、Remote 等；

Subject 是 Commit 目的的简短描述，不超过 50 个字符。

Body 部分是对本次 commit 的详细描述，可以分成多行。

当提交代码与上一个版本不兼容或针对某个 issue 则需要 footer。

下面是一个例子。

xxxx

[DS-001][docs-zh] add commit message

commit message RIP
build some conventions
help the commit messages become clean and tidy
help developers and release managers better track issues and clarify the optimization in the version iteration

This closes #001

接下来，我来演示如何在 DolphinScheduler 文档中通过纠错单词和错误语法来提交 PR。

比如，如果我们在官网看到关于 DolphinScheduler 的硬件环境中有错误的单词和语法，我们可以自行提交 issue 或者他人发布 issue 来暴露这个问题。

首先，我们找到这个问题的 issue，并留言我们会接管该问题。

接下来分为以下几步：

首先，fork 和 clone 文档项目仓库（因为我们是对官网进行修改，所以需要 fork website 项目，如果需要给 DolphinScheduler 项目提交则换成 DolphinScheduler 项目即可）。接下来是新建分支改动，最后 Push 和提交 PR。

再讲解下详细步骤。首先我们打开 website 的仓库，我们需要在自己的 GitHub 中 fork 官方的 ds-website 项目。

然后我们通过 git clone 克隆 ds-website 项目，如果网络不通的同学可以通过设置 git proxy 来下载。

下载完成之后，我们使用 IDEA 加载项目。这里我已经提前打开了项目。

接着我们新建一个分支，根据前面提到的 PR 分支命名规则设置为 bug-Issue 号, bug-6939。

我们需要找到硬件环境（https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/installation/hardware.html）这篇文章，首先找到对应的版本 2.0.0，再找到 url 中对应的 hardware.html 文件在 /user_doc/guide/installation 文件夹下。

接着我们对错误的单词和语法进行修正。

所有的改动结束之后，我们需要先 commit 这次的改动并根据官方要求填写Commit Message。

再将分支 push 到我们的 GitHub 中。

最后，GitHub 提示我们的改动可以提交 PR，点击 compare & pull request 提交 PR 并按照官方要求描述 PR 标题。

这样，我们的 PR 就提交好了！后续如果有任何改动依然可以对该分支进行提交。

提交 PR 的后续：