设为首页收藏本站

                      LUPA开源社区

                       ?#19968;?#23494;码
                       注册
                      文章 帖子 博客

                      如何参与一个GitHub开源项目?

                      2014-4-15 14:40| 发布者: 红黑魂| 查看: 13678| 评论: 1|来自: CSDN

                      摘要: 最近一年开源项目特别的热,很多技术大会或论坛都以开源项目作为主题进行探讨,可见这是一种趋势。而Github作为开源项目的著名托管地,可谓无人不知,越来越多的个人和公司纷纷加入到Github的大家族里来,为开源尽一 ...

                      最近一年开源项目特别的热,很多技术大会或论坛都以开源项目作为主题进行探讨,可见这是一种趋势。而Github作为开源项目的著名托管地,可谓无人不知,越来越多的个人和公司纷纷加入到Github的大家族里来,为开源尽一份绵薄之力。对于个人来讲,你把自己的项目托管到Github上并不表示你参与了Github开源项目,只能?#30340;?#24320;源了自己的项目,可以任别人自?#19978;?#36733;。

                      那么该如何参与Github的开源项目呢?相信很多人都有这方面的疑问,网上也有一些参差不齐的?#22363;探?#22823;家如何“Pull Request?#34180;?#22914;何“Commit”等等。但这些?#22363;?#24448;往不够全面或不够完全正确,搞不好可能让你陷入一个误区。鉴于此,前几天Github官方团?#26377;?#20102;一篇很棒的文章 Contributing to Open Source on GitHub,专业指导大家如何参与Github的开源项目。 下面是 原文的翻译。


                      参与开源项目的最佳办法就是加入到你正在使用的已有项目上来。Github上有500多万开源项目,涉及到各个领域的技术,像 recipesHTML/CSSRubyAstrophysics等等。该指南将涵盖你在一个典型的项目中可能出现的事情以及如何为开源项目作出贡献。

                      找项目

                      我们推荐你从已正在使用的或?#34892;?#36259;的项目开始。这里有几个很棒的地方供你参考:

                      一个典型的项目

                      下面是一些你在Github开源项目中可能遇到的因素。

                      The Community(社区)

                      项目通常会有一个社区维护,由不同角色(正规或非正规)的其他用户组成:

                      • 所有者(Owner):即创建该项目?#20197;?#20182;们Github账户上有该项目的用户或组织。 
                      • 维护者?#25176;?#20316;者(Maintainers and Collaborators): 致力于一个项目并促进该项目发展的用户。通常所有者和维护者是同一个用户或组织,他们对项目库都?#34892;?#30340;权限。 
                      • 贡献者(Contributors)?#22909;?#19968;个对该项目发出过pull request并合并到项目中的用户都是贡献者。
                      • 社区成员(Community Members):即那些经常使用且非常关心该项目的用户,他们在讨论功能特征和pull request上非常活?#23613;?/li>

                      The Docs(文档)

                      一般项目中都有的文件。

                      • Readme:几乎所有的Github项目都包含一个README.md文件。readme提供了该项目的一个概览及关于如何使用、构建甚至如何贡?#23376;?#19968;个项目的相关细节。
                      • Contributing:项目和项目维护者不同,所以每个项目所期望的作贡献的最佳方法也会有所不同。一定要注意一个标注为CONTRIBUTING的文档,Contributing文档详?#35813;?#36848;了一个项目的维护者希望看到贡献的补丁或功能应该符合怎样的规格。这可能包含要写什么测试,代码语法规范或补丁集中的区域。
                      • License:一个LICENSE文件当然就是该项目的许可证了。一个开源项目的license会告诉用户他们能做和不能做的(例如使用、修改、重新发布),及告诉贡献者他们允许其他人做的。?#34892;?#22810;的办法对开源项目加上许可证,你可以在 choosealicense.com读到更多的关于每个许可证的含义。
                      • Documentation and Wikis:许多大型项目有的不只有一个readme来指导人么如何使用他们的项目。在这种情况下你通常能够发现一个指向库中名为“docs”的另一个文件或文件夹的链接。


                      另外,该库也可能使用Github wiki来代替文档。 

                       

                      贡?#23376;?#19968;个项目

                      ?#28909;?#20320;已经找到了理解该项目的相关资?#24076;?#19979;面你就可以采取一些行动了。

                      建立一个话题

                      如果你发现了你正在使用的项目中的一个bug(但是你不知道怎么去修?#27492;?#25110;对文档有不解或对项目有疑问 — 那么创建一个话题吧!这非常容易且一般你不管创建什么话题,你都可能不是唯一一个出现该问题的人,所以其他人可能会发现你的话题很有帮助。关于更多的话题介绍,请查看我们的Issues guide

                      话题专业提示

                      • 在建话题之前检查已有的话题:话题重复对双方都无利,所以搜索整个正开放和已关闭的话题以检查你遇到的问题是否已经有人解决了。 
                      • 务必对自己的问题有清晰的认识:期望的结果是什么?然而却发生了什么? 详?#35813;?#36848;其他人如何重现该问题。
                      • 在像 JSFiddle或 CodePen类似的?#25945;?#19978;重现该问题并给出问题demo的链接。 
                      • 包含一些系统相关的细节,比如用的什么浏览器、库或操作系统及版本号。 
                      • 在你的话题或在 Gist里贴出你的错误输出或日?#23613;?#22914;果在话题里贴出来,请用三个反引号``` 包围起来使得能够?#24049;?#30340;呈?#25351;?#22823;家。

                      Pull Request

                      如果你能够修复bug或自己添加功能 — 太棒了,请发一个pull request吧!确保你已经读过任何关于contributing的文档,且需要理解license以及已经签过CLA(如果需要的话)。一旦你提交了一个pull request,维护者就会将你的?#31181;?#19982;已有的?#31181;?#20316;比较来决定是否要合并(即pull in)你作的改动。

                      Pull Request专业提示


                      开放的Pull Requests

                      一旦你打开一个pull request,就会有一个讨论,围绕你提出的改变作出探讨。其他的贡献者和用户可能会参与进来,但最终由维护者做决定。你可能会被要求?#38405;?#30340;pull request做一些改变,如果这样,请给你的?#31181;?#28155;加更多的commit并push它们 — 它们将自动的加入到已有的pull request里。

                      如果你的pull request被合并了——太好了!如果没被合并的话,也没什么大不了的,也许这不是项目维护者所期望看到的改动,亦或者他们已经致力于该bug或功能。这种情况有可能发生,所以我们的建议是:对收到的结果做出反馈,进一步努力然后再次pull request出去— 或者创建你自己的开源项目。

                      VIA GitHub & CSDN 博客


                      酷毙

                      雷人

                      鲜花

                      鸡蛋

                      漂亮
                      • 快毕业了,没工作经验,
                        找份工作好难啊?
                        赶紧去人才芯片公司磨练吧!!

                      最新评论

                      关于LUPA|人才芯片工程|人才招聘|LUPA?#29616;?/a>|LUPA教育|LUPA开源社区 ( 浙B2-20090187  

                      返回顶部
                      双色球中奖图片

                                                              p5走势图带连线图表 福利彩票里面有极速赛车吗 pk10冠军固定公式技巧 湖北快三专家推荐号码 网易老时时结果 幸运28app官网下载 山东时时网站诈骗 快乐时时官网下载手机版下载 彩金捕鱼游戏 华东十五选五专家推荐