导致了文档欧宝官网下载app
编辑该页面导致了文档欧宝官网下载app
在你的第一个贡献
之前的贡献,您需要:
- 注册一个免费GitHub账户,Symfony的服务文档托管。欧宝官网下载appob娱乐下载
- 熟悉reStructuredText标记语言,用于写Symfony文档。ob娱乐下载读这篇文章一个快速概述。
快速在线捐款
如果你做一个相对较小的变化——比如修复一个错误或说辞——贡献的最简单方法是直接在GitHub !你可以在你阅读Symfony的文档。欧宝官网下载appob娱乐下载
步骤1。点击编辑该页面按钮在右上角,您将被重定向到GitHub:
步骤2。编辑内容,描述您的更改,然后点击建议文件更改按钮。
步骤3。GitHub现在将创建一个分支,提交您的更改(如果这是你第一分叉库第一贡献),它还将显示一个预览你的变化:
如果一切都是正确的,点击创建拉请求按钮。
步骤4。GitHub将显示一个新页面,你可以做一些最后的更改请求在创建它。对于简单的贡献,您可以安全地忽略这些选项并点击创建拉请求按钮一次。
恭喜你!您刚刚创建了一个拉请求Symfony官方文档!欧宝官网下载appob娱乐下载社区将回欧宝体育平台怎么样顾你的拉请求和(可能)建议调整。
如果你的贡献是大或如果你喜欢你自己的电脑上工作,继续阅读本指南学习另一种方法来将请求发送到Symfony文档。欧宝官网下载appob娱乐下载
你的第一个文档的贡献欧宝官网下载app
在本节中,您将学习如何导致首次Symfony的文档。欧宝官网下载appob娱乐下载下一节将解释短流程你将来会跟每一个贡献后你的第一个。
假设你想提高安装指南。为了使您的更改,请执行以下步骤:
步骤1。Symfony官方文档存储库位于欧宝官网下载appob娱乐下载github.com/ob娱乐下载symfony/symfony-docs,然后点击叉按钮叉存储库你的个人账户。这是只需要你第一次Symfony。ob娱乐下载
步骤2。克隆分叉的存储库到您的本地机器(本例中使用项目/ symfoob娱乐下载ny-docs /
目录存储文档;欧宝官网下载app相应改变这个值):
1 2
美元cd项目/美元git克隆git@github.com: YOUR-GITHUB-USERNAMEob娱乐下载 / symfony-docs.git
步骤3。添加原Symfony文档库作为“Gob娱乐下载it远程执行这个命令:
1 2
美元cdob娱乐下载symfony-docs /美元git远程上游添加https://github.com/symfony/symfonyob娱乐下载-docs.git
如果一切顺利,您将看到以下当清单项目的“遥控器”:
1 2 3 4 5
美元git远程- v起源git@github.com: YOUR-GITHUB-USERNAME / symfony-ob娱乐下载docs.git(获取)起源git@github.com: YOUR-GITHUB-USERNAME / symfony-docs.git(推)上游https://github.com/symfony/symfony-docs.git(获取)上游https://github.com/symfony/symfony-docs.git(推)
获取所有上游的提交分支机构通过执行这个命令:
1
美元git获取上游
这一步的目的是允许您同时工作在Symfony官方库和自己的叉。ob娱乐下载你会看到在行动。
步骤4。创建一个专门的新分支为你改变。使用一个短暂而难忘的分公司的名称(如果你解决报告问题,使用fix_XXX
作为分公司名称,XXX
是这个问题的数量):
1
美元git checkout - b improve_install_article上游/ 5.4
在这个例子中,分支机构的名称improve_install_article
和上游/ 5.4
值告诉Git的基础上创建这个分支5.4
分支的上游
远程,这是最初的Symfony文档存储库。ob娱乐下载
应该根据修复古老的维护分支它包含错误。现在这是5.4
分支。如果你不是记录一个新的功能,切换到第一个Symfony版本,包括,例如:ob娱乐下载上游/ 6.2
。
第5步。现在让你的文档的变化。欧宝官网下载app添加、调整、改写甚至删除任何内容和尽力遵守欧宝官网下载app文档标准。然后提交你的变化!
1 2 3
#如果修改之前的内容美元git添加setup.rst美元git commit setup.rst
步骤6。推更改你的存储库:
1
美元git push improve_install_article起源
的起源
值的名称远程对应于你的库和Gitimprove_install_article
是您在前面创建的名字分支。
步骤7。一切都是现在准备启动把请求。去你的仓库https://github.com/YOUR-GITHUB-USERNAME/ob娱乐下载symfony-docs
,然后点击把请求链接位于侧边栏。
然后,点击大新的拉请求按钮。GitHub不能猜的变化,你想建议,选择适当的分支,变化应该被应用:
在这个例子中,基地叉应该是ob娱乐下载symfony / symfony-docs
和基地部门应该5.4
,这是你选择的分支基地你的变化。的头叉应该是你的份吗ob娱乐下载symfony-docs
和比较分支机构应improve_install_article
的名字,这是您创建的分支,你让您的更改。
步骤8。最后一步是准备描述拉的请求。短词或段落描述拟议中的变化足以确保可以回顾你的贡献。
第9步。现在您已经成功提交你的第一个贡献Symfony的文档,欧宝官网下载appob娱乐下载去庆祝!文档管理欧宝官网下载app人员将仔细审查你的工作在短时间内,他们会让你知道任何需要改变。
如果你被要求添加或修改,不创建一个新的请求。相反,确保你在正确的分支,使你改变和推动新变化:
1 2 3 4 5 6
美元cd项目/ symfoob娱乐下载ny-docs /美元git checkout improve_install_article#……你的变化美元git推
第10步。拉请求最终接受,合并后在Symfony的文档,你将被包含在欧宝官网下载appob娱乐下载ob娱乐下载Symfony文欧宝官网下载app档贡献者列表。此外,如果你碰巧有一个ob娱乐下载SymfonyConnect配置文件,你会得到一个酷ob娱乐下载Symfony文欧宝官网下载app档徽章。
你的下一个文档的贡献欧宝官网下载app
看看你!你已经做出了你的第一个贡献Symfony文档!欧宝官网下载appob娱乐下载有人抛出一个聚会!你的第一个贡献了一点额外的时间,因为你不得不学习一些标准和设置您的电脑。但是从现在开始,你的贡献将会更容易完成。
这是一个检查表通过你的下一个步骤将指导您的贡献Symfony文档:ob娱乐下载
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
#创建一个新的分支基于最古老的维护版本美元cd项目/ symfoob娱乐下载ny-docs /美元git获取上游美元git checkout - b my_changes上游/ 5.4#……你的变化#(可选)如果这是一个新内容添加您的更改美元git添加xxx.rst#提交您的更改并推动你的叉子美元git commit xxx.rst美元git push my_changes起源#……去GitHub创建请求#(可选)修改评论家和提交请求的美元git commit xxx.rst美元git推
在完成你的下一个贡献,也看你的排名提高的列表ob娱乐下载Symfony文欧宝官网下载app档贡献者。你猜对的:毕竟这艰苦的工作,它是时间再次庆祝!
回顾你的变化
ob娱乐下载Symfony库检查每个拉请求自动寻找常见错误,不恰当的单词,语法问题代码块等。
选择你也可以构建文档在本地机器调试问题或离线阅读文档。欧宝官网下载app要做到这一点,包括在遵循指令symfony-docs库的READMob娱乐下载E文件。
常见问题
为什么花了这么长时间我的变化被审查和/或合并?
请耐心等待。它需要前几天你把请求可以完全了。合并后的变化,它可能需要几个小时前你的变化出现在Symfony的网站。ob娱乐下载
我为什么要使用最古老的维护分支而不是最新的分支?
符合Symfony的源代码,文档ob娱乐下载存储库分为多个分支,对应于不同版本的Symfony本身欧宝官网下载app。最新的(如。5.倍
)部门持有的文档开发代码的分支。欧宝官网下载app
除非你记录一个特性,介绍了在Symfony 5.4,应该是基于你的变化ob娱乐下载5.4
分支。欧宝官网下载app文档管理人员还将使用必要Git-magic应用您的更改的文档的所有活跃的分支。
如果我想提交我的工作没有完全完成吗?
你能做到。但请使用这两个前缀让评论家知道关于你的工作的状态:
(在制品)
(工作),当你还没有完成你的请求,但你会喜欢它。拉请求不会被合并,直到你说它是准备好了。(WCM)
(等待代码合并)当你记录一个新的功能或改变还没有接受到核心代码。把请求才会被合并是合并的核心代码(或关闭如果更改被拒绝)。
你会接受一个巨大的拉力要求的变化?
首先,确保变化有些关联。否则,请创建单独的请求。之前提交一个巨大的变化,这可能是一个好主意来打开一个问题在Symfony文档存储库问经理是否同意你的修改建议。欧宝官网下载appob娱乐下载否则,他们可能会拒绝你的建议后,你把所有的努力作出更改。我们肯定不希望你浪费你的时间!