拉取请求

如何创建优秀的拉取请求

拉取请求（PR）是你向 Exercism 代码库的某个部分提交改动提议的方式。 如果你正在读这篇文章，并且正在准备一个 PR，谢谢你！ 本指南旨在帮你处理好 PR 中非技术性的部分，让你有愉快的体验，同时也帮到我们的维护团队。

你可以期待什么

PR 的流程是这样的：

  • 你提交一个 PR
  • 一位或多位维护者审查这个 PR，留下建议性的评论。 有时他们会从整体上讨论这个 PR，判断它是不是真的应该加进来。
  • 你的 PR 被合并，你会获得网站上的 Reputation。 或者你的 PR 被关闭。

怎样才能让 PR 被合并？

有些事情你可以提前做，让 PR 更有可能以尽量少的改动被合并。

最重要的一点是，在你提交 PR 之前，就确保维护者会欢迎你所做的改动。 最简单的做法，是先到 GitHub 上开一个 Issue，说明你打算做什么，并问问维护者是否愿意接受这些改动。

Note

如果你在 Exercism 网站上找到了一个 Task，那就不需要再开新的 Issue 了。 你可以在已有的 Issue 下评论，说你要来做这个，然后直接开始。

其次要确保的是，你打开 PR 时在里面留下清晰的描述。 没有描述的 PR 会让维护者极其头疼，因为他们读代码时没有任何背景信息。 告诉我们你为什么做这些改动，链接到 PR 对应的 Issue，解释你不得不做出哪些取舍，等等。

最后，确保你的 PR 里只包含与一个改进相关的改动。 如果你有多个改进，请把它们拆成多个 PR。 这样维护者审查起来更轻松、更快，你的日子也会更好过。

我需要等多久？

通常维护者会在几天内审查你的 PR。 第一周请不要不停地给 PR 追加内容来催进度。我们的维护者都是志愿者，平时很忙，会尽快抽空审查。 如果 7 天内还没有收到回复，请在 PR 上发一条新评论并@exercism/reviewers，这样就会提醒到更大的团队。

再次感谢你为 Exercism 做贡献。 希望这是一段有趣又有收获的经历！