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

译者 | 弯月

出品 | CSDN(ID:CSDNnews)

以下为译文:

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

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

阅读贡献准则

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

创建新分支

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

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

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

不要直接提交 PR ,先创建议题

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

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

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

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

不要提交不必要的文件

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

不要气馁

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

总结

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

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

声明:本文为 CSDN 翻译,转载请注明来源。

预约《大咖来了》直播,赢纪念版卫衣以及保温杯等礼品,在直播间精选留言提问题,若问题被采纳,将直接赠送马克杯!先到先得!

开源新手必看7个小技巧相关推荐

  1. cad 怎么显示块句柄_新手必看的CAD小技巧,老师傅精选汇总,三分钟教你学习用处多多...

    零基础新手必看的CAD绘图小技巧,这里分享给你,都是老师傅精选汇总,实实在在用得上,希望能够给你带去帮助! PS:其实CAD入门并不难,难在坚持,如果真的想要入这个行业,一定要你坚持哦! 废话不说了直 ...

  2. 电脑故障维修:新手必看的修电脑技巧!

    日常生活工作中,我们的电脑总会出现各种各样的问题,如果掌握了一定的通用修电脑技巧,除了可以解决问题,说不定还能得到帮女神修电脑的机会,俗话说的好,电脑修的好,对象少不了! 电脑故障判断一般本着先&qu ...

  3. 电脑音频服务未运行怎么解决_电脑故障维修技巧教程:新手必看的修电脑技巧!...

    日常生活工作中,我们的电脑总会出现各种各样的问题,如果掌握了一定的通用修电脑技巧,除了可以解决问题,说不定还能得到帮女神修电脑的机会,俗话说的好,电脑修的好,对象少不了!电脑故障判断一般本着先&quo ...

  4. 外汇投资新手必看!这些交易技巧帮你轻松入门

    外汇交易是一项高风险.高回报的金融投资活动,具备一定的技巧和知识可以帮助投资者更好地进行交易并提高盈利概率.以下是一些外汇交易技巧: 1. 技术分析:通过对历史价格和交易量数据的分析,预测未来价格趋势 ...

  5. python的难点_初学python的操作难点总结(新手必看篇)

    如下所示: 1 在cmd下 盘与盘之间的切换 直接 D或d: 就好 2 查找当前盘或者文件下面的目录 直接 dir 3 想在一个盘下进去一个文件夹,用cd空格目标文件 cd p 4 写文件的第一个字母 ...

  6. python新手入门总结_初学python的操作难点总结(新手必看篇)

    如下所示: 1 在cmd下 盘与盘之间的切换 直接 D或d: 就好 2 查找当前盘或者文件下面的目录 直接 dir 3 想在一个盘下进去一个文件夹,用cd空格目标文件 cd p 4 写文件的第一个字母 ...

  7. java游戏鹿鼎记怎么玩,鹿鼎记游戏中的小技巧新手必看攻略

    今天给大家带来的文章是关于鹿鼎记游戏中的小技巧新手必看,相信很多玩家对此还不是很了解吧,那么快来看看小编在接下来说的内容,希望能够喜欢. 一.合理利用外包任务,不活动也能得经验.奖励 有时候因为工作等 ...

  8. MacOS中Dock栏的设置和使用技巧,新手必看

    MacOS中Dock栏的设置和使用技巧,新手必看 Dock栏就是Mac放置常用应用程序和文件夹快捷方式的任务栏,为你访问这个应用和文件提供了非常方便的入口. 作为Mac用户最常使用的区域,要知道如何才 ...

  9. 【Mac新手必看】苹果macOS桌面壁纸设置技巧

    相信很多朋友像小编一样,喜欢设置各种有意思的桌面壁纸,不管是工作还是生活,每天对着自己喜欢的壁纸心情都超级棒呢~那这些Mac壁纸小技巧你们知道吗? 如何设置桌面壁纸? 你可以点击屏幕左上角的" ...

最新文章

  1. java解析五元组_pcap文件解析,并且按照五元组分类
  2. [手机分享]黑莓手机7系列分享之——黑莓7730
  3. html右键禁用和web页面中添加加入qq群的方式
  4. 2018 我的学习分享路线
  5. BZOJ1103: [POI2007]大都市meg
  6. ANSI编码和Unicode编码的不同
  7. H3C PPP基本概念
  8. 给 ABAP ALV 报表的数据行增添颜色效果试读版
  9. powershell 运行策略
  10. ISA Server 2004 0x80004005错误
  11. 如何查看现有项目的struts和hibernate和spring版本
  12. 快速排序总结,Python版
  13. linux 自学笔记
  14. SPOJ 104 Highways(最小生成树计数)
  15. Linux文件系统(七)---系统调用之open操作(三) 之 open_namei函数
  16. Windows下TexLive2015 TeXstudio 和SumatraPDF安装配置
  17. 清华同方计算机配置情况,清华同方计算机还原卡安装使用说明
  18. 【STM32H7的DSP教程】第13章 DSP快速计算函数-三角函数和平方根
  19. 晶体二极管及其基本应用电路
  20. Adobe PhotoShop V8.0

热门文章

  1. java中基本数据类型
  2. 在Chrome+Visual Studio中调试asp.net程序很慢的问题(Firefox也有类似问题)
  3. jqueryForm 异步上传图片文件
  4. 第一次使用并配置Hibernate
  5. Apache Mail 发送带附件的邮件
  6. iStream DDS
  7. 利用 MPI 求素数个数
  8. 生成对抗网络GAN损失函数loss的简单理解
  9. php抓娃娃机器,vue制作抓娃娃机 - osc_icwhzig7的个人空间 - OSCHINA - 中文开源技术交流社区...
  10. 【精品】Deepsort文章深度解析