开源新手必看7个小技巧

我就是我 2022-11-15 14:23 205阅读 0赞

【CSDN编者按】：万事开头难，成为开源大佬的第一步，是成为开源新手。先读他人的 CONTRIBUTING.MD，慢慢就会有了自己的贡献规则。

译者 | 弯月

出品 | CSDN（ID：CSDNnews）

转自｜CSDN

以下为译文：

多年来，我一直在参与几个代码库的维护工作，这些代码库的主要目的是帮助新手学习如何为开源做贡献，并给他们尝试开源的机会。

在维护这些开源代码库期间，我注意到了新手都会犯的一些常见的错误，还有一些他们常常感到疑惑的问题。因此，我决定撰写这篇文章，希望能够为打算向开源做贡献的新手提供一些帮助。

![5048a59ef1172fbd927338c5a6b62386.png][]

# **阅读贡献准则**    #

每个开源代码库中都有一个名为 CONTRIBUTING.MD 的文件。该文件中容纳了所有为该代码库做贡献的规则，包括代码变更指南以及如何贡献代码等。这个文件非常重要，仔细阅读该文件可以为你节省大量时间，帮助你弄清楚需要做什么，以及如何确保你的拉取请求（ PR ）符合项目的所有准则，同时还可以节省维护人员的时间，方便他们审核你的代码，并做出必要的修改。

![e5e57e58b0ffb65d80508face83c4437.png][]

# **创建新分支**    #

在贡献代码的时候，你需要做的第一件事情就是分叉项目，这样可以方便你修改并提交代码。然而，许多新手都会忽略创建新分支这个步骤。不要在分叉后，直接修改 master （主）分支。这一步对于维护人员，乃至整个项目都非常有帮助。

![2490570f8b835b3a314a4c3f0dc3e78c.png][]

# **在动手修改代码之前，请先确保议题已经分给了自己**    #

虽然有例外，但我认为大多数开源项目都采用了这种做法。我们应该确保修改的议题分给了自己。通常，在向某个项目贡献代码的时候，首先你应该去代码库的 Issue （议题）页面，看看自己能帮上什么忙。在找到自己可以帮忙解决的问题后，你应该先确保这个议题还没有分出去，然后留言，请求将它分给自己。许多新手会漏看某个议题已经分给了别人，或者忘了留言，最后导致维护人员看到多个 PR 解决同一个问题，甚至漏掉某个 PR 。为了避免这种情况，请首先在议题下面留言，确保议题分给了自己，然后再提交 PR 。

![e12d442fcc14891f970f658cd0c28506.png][]

# **不要直接提交 PR ，先创建议题**    #

有时你会发现某个 bug ，或者想到增强某个功能办法，而且代码库的议题列表中没有这个问题。这时，许多新手会直接动手改代码，然后发送 PR 。如果只是拼写错误之类的小问题，这种做法也没有太大问题。但是，如果遇到很大的变更，尤其是你认为自己的做法更好的时候，请首先发送一个议题，写清楚自己的建议或仔细汇报 bug 。如果维护人员认为你说的很有道理，他们就会把这个议题分给你。但是，如果出于某种原因，他们没有采纳你的建议，则他们会关闭议题，从而节省彼此的时间。

![82c426e84b9b125b1bd39ea7a88a460b.png][]

# **不需要在每次修改代码的时候都新建 PR**    #

我看到很多人都有这类的困惑，某个开发人员发送了一个 PR ，而我给出了修改建议，然后他会关闭这个 PR ，然后再新建一个 PR ，然后再修改代码。其实你不需要这么做。

你可以直接修改 PR ，然后提交代码即可。假设你分叉了代码库，并新建了一个分支 patch-1 ，那么只需在该分支上修改代码，然后提交并推送你的更改，则所有的代码变更都会自动显示在 PR 中。

![1ca1857283b1f8f8acba808463e7bb07.png][]

# **不要提交不必要的文件**    #

我收到的 PR 中经常会包含不必要的文件，比如 IDE 的配置文件等。在提交代码之前，请检查一下哪些文件发生了变化，只提交与你修改的议题相关的文件。

![0b2ff1d24b474c476aa9b3aaa61985d5.png][]

# **不要气馁**    #

有些开发人员犯了很多错误，但我依然很喜欢他们。因为他们告诉我自己是新手，因此我只能一次次地给他们机会，让他们改代码。老实说，我以为他们会关掉 PR ，然后退出。但是，他们一直在努力，而且随着时间一天天过去，他们不仅能出色地完成工作，而且还能够为其他议题贡献代码。新手犯错再所难免，而且你们会越来越好。

![1087d1d00e39e146856d23a431705f4f.png][]

# **总结**    #

如果你从未向开源做过贡献，或者你一直犹豫不决，那不如现在就动起来吧。为开源做贡献不仅可以回馈社区，而且自身也能得到成长。希望本文能对你有所帮助，并鼓励你加入开源。每一份微不足道的小贡献，都能让我们的社区变得越来越好。

原文链接：https://blog.shahednasser.com/tips-for-beginners-to-open-source/

声明：本文为 CSDN 翻译，转载请注明来源。

## 最后 ##

欢迎关注【前端瓶子君】✿✿ヽ(°▽°)ノ✿

回复「算法」，加入前端算法源码编程群，每日一刷（工作日），每题瓶子君都会很认真的解答哟！

回复「交流」，吹吹水、聊聊技术、吐吐槽！

回复「阅读」，每日刷刷高质量好文！

如果这篇文章对你有帮助，「在看」是最大的支持

![4af1a8ed7c69b74c27799ef486b4a688.png][]

》》面试官也在看的算法资料《《

“在看和转发”就是最大的支持

[5048a59ef1172fbd927338c5a6b62386.png]: /images/20221022/7d8d8b7636a6455395b3dc4389527a2e.png
[e5e57e58b0ffb65d80508face83c4437.png]: /images/20221022/563fa9e9f9c248cbb330181fa72d7d7f.png
[2490570f8b835b3a314a4c3f0dc3e78c.png]: /images/20221022/88c66e7dec7f4f01918730625fec8fd7.png
[e12d442fcc14891f970f658cd0c28506.png]: /images/20221022/85909f397e924bd7ad1a69741254cb45.png
[82c426e84b9b125b1bd39ea7a88a460b.png]: /images/20221022/7376f7050b5f4dab8531db6f39c5a77a.png
[1ca1857283b1f8f8acba808463e7bb07.png]: /images/20221022/2acad6bcd18743b0b75774e8355df34c.png
[0b2ff1d24b474c476aa9b3aaa61985d5.png]: /images/20221022/973c38fc47de42cda06969724564dbdf.png
[1087d1d00e39e146856d23a431705f4f.png]: /images/20221022/f50cbd3757cf495fa2f26fc4941ce541.png
[4af1a8ed7c69b74c27799ef486b4a688.png]: /images/20221022/040407dabe2e44f8876ba83c736a1f32.png