188bet.com社区 主页 业界资讯 技能文摘 查看内容

怎样参加一个GitHub开源项目?

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

m88 188bet uedbet 威廉希尔 明升 bwin 明升88 bodog bwin 明升m88.com 18luck 188bet unibet unibet Ladbrokes Ladbrokes casino m88明升 明升 明升 m88.com 188bet m88 明陞 uedbet赫塔菲官网 365bet官网 m88 help
摘要: 最近一年开源项目特别的热,许多技能大会或论坛都以开源项目作为主题进行谈论,可见这是一种趋势。而Github作为开源项意图闻名保管地,可谓无人不知,越来越多的个人和公司纷繁参加到Github的咱们族里来,为开源尽一 ...

最近一年开源项目特别的热,许多技能大会或论坛都以开源项目作为主题进行谈论,可见这是一种趋势。而Github作为开源项意图闻名保管地,可谓无人不知,越来越多的个人和公司纷繁参加到Github的咱们族里来,为开源尽一份绵薄之力。关于个人来讲,你把自己的项目保管到Github上并不表明你参加了Github开源项目,只能说你开源了自己的项目,能够任他人自在下载。

那么该怎样参加Github的开源项目呢?信任许多人都有这方面的疑问,网上也有一些良莠不齐的教程教咱们怎样“Pull Request”、怎样“Commit”等等。但这些教程往往不行全面或不行完全正确,搞不好或许让你堕入一个误区。鉴于此,前几天Github官方团队写了一篇很棒的文章 Contributing to Open Source on GitHub,专业辅导咱们怎样参加Github的开源项目。 下面是 原文的翻译。


参加开源项意图最佳方法便是参加到你正在运用的已有项目上来。Github上有500多万开源项目,涉及到各个领域的技能,像 recipesHTML/CSSRubyAstrophysics等等。该攻略将包括你在一个典型的项目中或许呈现的作业以及怎样为开源项目作出奉献。

找项目

咱们引荐你从已正在运用的或感兴趣的项目开端。这儿有几个很棒的当地供你参阅:

一个典型的项目

下面是一些你在Github开源项目中或许遇到的要素。

The Community(社区)

项目一般会有一个社区保护,由不同人物(正规或非正规)的其他用户组成:

  • 一切者(Owner):即创立该项目且在他们Github账户上有该项意图用户或安排。 
  • 保护者和协作者(Maintainers and Collaborators): 致力于一个项目并促进该项目开展的用户。一般一切者和保护者是同一个用户或安排,他们对项目库都有写的权限。 
  • 奉献者(Contributors):每一个对该项目发出过pull request并兼并到项目中的用户都是奉献者。
  • 社区成员(Community Members):即那些常常运用且十分关怀该项意图用户,他们在谈论功用特征和pull request上十分活泼。

The Docs(文档)

一般项目中都有的文件。

  • Readme:简直一切的Github项目都包括一个README.md文件。readme供给了该项意图一个概览及关于怎样运用、构建乃至怎样奉献于一个项意图相关细节。
  • Contributing:项目和项目保护者不同,所以每个项目所希望的作奉献的最佳方法也会有所不同。必定要注意一个标示为CONTRIBUTING的文档,Contributing文档详细描述了一个项意图保护者希望看到奉献的补丁或功用应该契合怎样的标准。这或许包括要写什么测验,代码语法标准或补丁会集的区域。
  • License:一个LICENSE文件当然便是该项意图许可证了。一个开源项意图license会告知用户他们能做和不能做的(例如运用、修正、从头发布),及告知奉献者他们答应其他人做的。有许多的方法对开源项目加上许可证,你能够在 choosealicense.com读到更多的关于每个许可证的意义。
  • Documentation and Wikis:许多大型项目有的不只有一个readme来辅导人么怎样运用他们的项目。在这种状况下你一般能够发现一个指向库中名为“docs”的另一个文件或文件夹的链接。


别的,该库也或许运用Github wiki来替代文档。 

 

奉献于一个项目

已然你现已找到了了解该项意图相关材料,下面你就能够采纳一些行动了。

树立一个论题

假如你发现了你正在运用的项目中的一个bug(可是你不知道怎样去修正它),或对文档有不解或对项目有疑问 — 那么创立一个论题吧!这十分简单且一般你不论创立什么论题,你都或许不是仅有一个呈现该问题的人,所以其他人或许会发现你的论题很有协助。关于更多的论题介绍,请查看咱们的Issues guide

论题专业提示

  • 在建论题之前查看已有的论题:论题重复对两边都无利,所以查找整个正敞开和已封闭的论题以查看你遇到的问题是否现已有人处理了。 
  • 必须对自己的问题有明晰的知道:希望的成果是什么?可是却发生了什么? 详细描述其他人怎样重现该问题。
  • 在像 JSFiddle或 CodePen相似的平台上重现该问题并给出问题demo的链接。 
  • 包括一些体系相关的细节,比方用的什么浏览器、库或操作体系及版本号。 
  • 在你的论题或在 Gist里贴出你的过错输出或日志。假如在论题里贴出来,请用三个反引号``` 包围起来使得能够杰出的呈现给咱们。

Pull Request

假如你能够修正bug或自己增加功用 — 太棒了,请发一个pull request吧!保证你现已读过任何关于contributing的文档,且需求了解license以及现已签过CLA(假如需求的话)。一旦你提交了一个pull request,保护者就会将你的分支与已有的分支作比较来决议是否要兼并(即pull in)你作的改动。

Pull Request专业提示

  • Fork 该项目库及将它clone到本地。经过增加为长途的方法在本地连接到本来的‘upstream’库。常常从‘upstream’库pull in改动以坚持库最新,这样当你提交pull request时,就不大或许发生兼并抵触了。点 这儿看更多的辅导细节。 
  • 为你的修改独自树立一个分支 。
  • 必须清楚所呈现的问题以及怎样重现该问题或为什么你的功用有协助。然后相同的要清楚做一些改动有哪些过程。 
  • 最好测验一下。在任何已有的测验(假如存在)上运转你所做的改动并在必要时创立新的测验。不论测验存不存在,都要保证你的改动不会损坏已有的项目。 
  • 假如你的改动包括了HTML/CSS方面的不同,那么请包括改动前和改动后的截图。将你的图片拖放到你pull request的正文里。 
  • 尽你所能的在项意图风格上多做尽力。这或许意味着运用不同于你自己Github库中选用的缩进,分号或注释,可是这让保护者更简单兼并,也让其他人更简单了解和今后的保护。


敞开的Pull Requests

一旦你翻开一个pull request,就会有一个谈论,环绕你提出的改动作出谈论。其他的奉献者和用户或许会参加进来,但终究由保护者做决议。你或许会被要求对你的pull request做一些改动,假如这样,请给你的分支增加更多的commit并push它们 — 它们将主动的参加到已有的pull request里。

假如你的pull request被兼并了——太好了!假如没被兼并的话,也没什么大不了的,或许这不是项目保护者所希望看到的改动,亦或许他们现已致力于该bug或功用。这种状况有或许发生,所以咱们的主张是:对收到的成果做出反应,进一步尽力然后再次pull request出去— 或许创立你自己的开源项目。

VIA GitHub & CSDN 博客

  • 快毕业了,没作业经验,
    找份作业好难啊?
    赶忙去人才芯片公司锻炼吧!!

最新谈论

关于LUPA|人才芯片工程|人才招聘|LUPA认证|LUPA教育|188bet.com社区 ( 浙B2-20090187  

回来顶部