导致了文档欧宝官网下载app
编辑该页面警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 2.6,不再维护。
读这个页面的更新版本Symfob娱乐下载ony 6.3(当前的稳定版本)。
导致了文档欧宝官网下载app
Symfony项目的基本原则之一ob娱乐下载欧宝官网下载app文档和代码一样重要。这就是为什么大量的资源用于记录新特性和保持其余的文档更新。欧宝官网下载app
世界各地的700多名开发人员Symfony的文档做出了贡献,我们很高兴你正在考虑加入这个大家庭。欧宝官网下载appob娱乐下载本指南将解释所有你需要为Symfony文档。欧宝官网下载appob娱乐下载
在你的第一个贡献
之前的贡献,你应该考虑以下:
- ob娱乐下载Symfony的欧宝官网下载app文档是用写的reStructuredText标记语言。如果你不熟悉这种格式,阅读这篇文章一个快速概述其基本特征。
- ob娱乐下载在Symfony欧宝官网下载app文档GitHub。你需要一个GitHub用户帐户为文档。欧宝官网下载app
- ob娱乐下载Symfony文欧宝官网下载app档发表下Creative Commons冲锋队3.0许可证和所有你的贡献将隐式地坚持,许可证。
你的第一个文档的贡献欧宝官网下载app
在本节中,您将学习如何导致首次Symfony的文档。欧宝官网下载appob娱乐下载下一节将解释短流程你将来会跟每一个贡献后你的第一个。
假设你想提高安装Symfony的书的一章。ob娱乐下载为了使您的更改,请执行以下步骤:
步骤1。Symfony官方文档存储库位于欧宝官网下载appob娱乐下载github.com/ob娱乐下载symfony/symfony-docs和叉存储库你的个人账户。这是只需要你第一次Symfony。ob娱乐下载
步骤2。克隆分叉的存储库到您的本地机器(本例中使用项目/ symfoob娱乐下载ny-docs /
目录存储文档;欧宝官网下载app相应改变这个值):
1 2
美元cd项目/ git美元克隆git: / /github.com/ <你的GITHUB用户名> / symfob娱乐下载ony-docs.git
步骤3。切换到古老的维护分支之前做任何改变。现在这是2.3
分支机构:
1 2
美元cdob娱乐下载symfony-docs / $ 2.3 git checkout
如果你不是记录一个新的功能,切换到第一个Symfony版本包括:ob娱乐下载2.5
,2.6
等。
步骤4。创建一个专门的新分支为你改变。这极大地简化了工作的回顾和合并您的更改。使用一个短暂而难忘的分公司的名称:
1
git checkout - b improve_install_chapter美元
第5步。现在让你的文档的变化。欧宝官网下载app添加、调整、改写甚至删除任何内容,但是确保你遵守欧宝官网下载app文档标准。
步骤6。推更改你的存储库:
1 2
美元/安装git提交书。rst git推动美元origin improve_install_chapter
步骤7。一切都是现在准备启动把请求。去你的仓库https / /github.com/ <你的GITHUB用户名> / symfob娱乐下载ony-docs
,然后点击把请求链接位于侧边栏。
然后,点击大新的拉请求按钮。GitHub不能猜的变化,你想建议,选择适当的分支,变化应该被应用:
在这个例子中,基地叉应该是ob娱乐下载symfony / symfony-docs
和基地部门应该2.3
,这是你选择的分支基地你的变化。的头叉应该是你的份吗ob娱乐下载symfony-docs
和比较分支机构应improve_install_chapter
的名字,这是您创建的分支,你让您的更改。
步骤8。最后一步是准备描述拉的请求。以确保你的工作进展很快,请添加以下表的开头你把要求描述:
1 2 3 4 5 6
|问| | - - - - - - - - - - - - - | - - - |医生修复吗?(是的|不)| |新文档吗?| |否](PR # symfony /ob娱乐下载 symfony如适用)|适用于| (symfony版本号这适用于)| |固定门票(门票固定的逗号分隔列表公关)
在这个例子中,这个表看起来如下:
1 2 3 4 5 6
|问| | - - - - - - - - - - - - - | - - - |医生修复吗?|是|新文档吗?| |没有适用于所有固定机票| | | # 10575
第9步。现在您已经成功提交你的第一个贡献Symfony的文档,欧宝官网下载appob娱乐下载去庆祝!文档管理欧宝官网下载app人员将仔细审查你的工作在短时间内,他们会让你知道任何需要改变。
如果你需要添加或修改任何东西,不需要创建一个新的请求。只要确保你在正确的分支,使你改变,推动他们。
1 2 3 4 5 6
美元cd项目/ symfoob娱乐下载ny-docs / git checkout improve_install_chapter美元#……你的变化git推动美元
第10步。拉请求最终接受,合并后在Symfony的文档,你将被包含在欧宝官网下载appob娱乐下载ob娱乐下载Symfony文欧宝官网下载app档贡献者列表。此外,如果你碰巧有一个SensioLabsConnect配置文件,你会得到一个酷ob娱乐下载Symfony文欧宝官网下载app档徽章。
你的第二个文档的贡献欧宝官网下载app
第一个贡献花了一些时间,因为你不得不叉库,学习如何编写文档,符合拉请求标准,等。第二个贡献将会容易得多,除了一个细节:考虑到愤怒的Symfony文档存储库的更新活动,奇怪的是,你的叉子现在过时与欧宝官网下载app官方的库。ob娱乐下载
解决这个问题需要你同步你的叉子与原来的库。要做到这一点,首先执行这个命令原始告诉git存储库:
1 2
美元cd上游项目/ symob娱乐下载fony-docs /美元git远程添加https://github.com/symfony/symfony-docs.git
现在你可以同步你的叉子通过执行下面的命令:
1 2 3 4
美元cd项目/ symfoob娱乐下载ny-docs / git获取上游git checkout 2.3美元git合并上游/ 2.3美元
这个命令将更新2.3
的分支,是你用来创建您的更改的新分支。如果你用另一个基地分支。主
,替换2.3
用适当的分支的名字。
太棒了!现在你可以继续遵循相同的步骤在前一节中解释说:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
#创建一个新的分支基于2.3分支保存您的更改美元cd项目/ symfoob娱乐下载ny-docs / git checkout 2.3美元git checkout - b my_changes#……你的变化#你的叉形存储库提交更改git添加xxx.rst美元#(可选)如果这是一个新内容git commit xxx美元。rst git推动美元origin my_changes#去GitHub创建请求## Include这个表的描述:# | |一个# | - - - - - - - - - - - - - | - - - - - -# |医生修复吗?|(是的|不)# |新文档吗?| |否](PR # symfony /ob娱乐下载 symfony如果适用的话)# | |适用于(Symfony版本ob娱乐下载号这适用于)# | |固定门票(门票固定的逗号分隔列表公关)
你的第二个贡献现在已经完成再去庆祝!你也可以看看你的排名提高的列表中ob娱乐下载Symfony文欧宝官网下载app档贡献者。
你的下一个文档的贡献欧宝官网下载app
既然你已经做了两个贡献Symfony文档,您可能熟悉所有Git-magic参与这个过程。欧宝官网下载appob娱乐下载这就是为什么你的下一个贡献会快得多。在这里你可以找到完整的步骤有助于Symfony文档,您可以使用欧宝官网下载appob娱乐下载检查表:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30
#同步你的叉与官方Symfony库ob娱乐下载美元cd项目/ symfoob娱乐下载ny-docs / git获取上游git checkout 2.3美元git合并上游/ 2.3美元#从最古老的维护版本创建一个新的分支git checkout 2.3美元git checkout - b my_changes#……你的变化#添加和提交您的更改git添加xxx.rst美元#(可选)如果这是一个新内容git commit xxx美元。rst git推动美元origin my_changes#去GitHub创建请求## Include这个表的描述:# | |一个# | - - - - - - - - - - - - - | - - - - - -# |医生修复吗?|(是的|不)# |新文档吗?| |否](PR # symfony /ob娱乐下载 symfony如果适用的话)# | |适用于(Symfony版本ob娱乐下载号这适用于)# | |固定门票(门票固定的逗号分隔列表公关)#(可选)修改评论家和提交请求的git commit xxx美元。rst git推动美元
你猜对的:毕竟这艰苦的工作,它是时间再次庆祝!
回顾你的变化
每一个GitHub拉请求自动构建和部署Platform.sh在一个环境,你可以在你的浏览器访问检查你
的变化。
访问Platform.sh环境URL简单地去拉请求
页面在GitHub和点击细节
。
请注意
特定的配置文件的根源Git存储库:.platform.app.yaml
,.platform / services.yaml
和.platform / routes.yaml
允许Platform.sh建立拉请求。
微小的变化(例如拼写错误)
你会发现只是一个错误,想修好它。由于GitHub的功能前端,很简单的创建将请求直接在浏览器中阅读文档在www.pdashmedia.com。ob娱乐下载要做到这一点,只需点击编辑该页面按钮在右上角。之前,请切换到右分支如前所述。现在你可以编辑的内容和描述您的更改在GitHub前端。当你的工作完成,点击建议文件更改创建一个承诺,这是你的第一个贡献,还你的叉子。自动创建一个新的分支,以提供一个基地为您的请求。然后填写表格创建拉请求如上所述。
常见问题
为什么花了这么长时间我的变化被审查和/或合并?
请耐心等待。它需要前几天你把请求可以完全了。合并后的变化,它可能需要几个小时前你的变化出现在www.pdashmedia.com网站上。ob娱乐下载
我为什么要使用最古老的维护分支而不是主分支?
符合Symfony的源代码,文档ob娱乐下载存储库分为多个分支,对应于不同版本的Symfony本身欧宝官网下载app。的主
分支机构持有的文档开发代码的分支。欧宝官网下载app
除非你记录一个特性,介绍了在Symfony 2.3,应该是基于你的变化ob娱乐下载2.3
分支。欧宝官网下载app文档管理人员还将使用必要Git-magic应用您的更改的文档的所有活跃的分支。
如果我想提交我的工作没有完全完成吗?
你能做到。但请使用这两个前缀让评论家知道关于你的工作的状态:
(在制品)
(工作),当你还没有完成你的请求,但你会喜欢它。拉请求不会被合并,直到你说它是准备好了。(WCM)
(等待代码合并)当你记录一个新的功能或改变还没有接受到核心代码。把请求才会被合并是合并的核心代码(或关闭如果更改被拒绝)。
你会接受一个巨大的拉力要求的变化?
首先,确保变化有些关联。否则,请创建单独的请求。之前提交一个巨大的变化,这可能是一个好主意来打开一个问题在Symfony文档存储库问经理是否同意你的修改建议。欧宝官网下载appob娱乐下载否则,他们可能会拒绝你的建议后,你把所有的努力作出更改。我们肯定不希望你浪费你的时间!