在你的第一个贡献

之前的贡献,您需要:

• 注册一个免费GitHub账户,Symfony的服务文档托管。欧宝体育电话欧宝娱乐app下载地址
• 熟悉reStructuredText标记语言,用于写Symfony文档。欧宝娱乐app下载地址读这篇文章一个快速概述。

快速在线捐款

如果你做一个相对较小的变化——比如修复一个错误或说辞——贡献的最简单方法是直接在GitHub !你可以在你阅读Symfony的文档。欧宝体育电话欧宝娱乐app下载地址

步骤1。点击编辑该页面按钮在右上角,您将被重定向到GitHub:

步骤2。编辑内容,描述您的更改,然后点击建议文件更改按钮。

步骤3。GitHub现在将创建一个分支,提交您的更改(如果这是你第一分叉库第一贡献),它还将显示一个预览你的变化:

如果一切都是正确的,点击创建拉请求按钮。

步骤4。GitHub将显示一个新页面,你可以做一些最后的更改请求在创建它。对于简单的贡献,您可以安全地忽略这些选项并点击创建拉请求按钮一次。

恭喜你!您刚刚创建了一个拉请求Symfony官方文档!欧宝体育电话欧宝娱乐app下载地址社区将回欧宝下载链接顾你的拉请求和(可能)建议调整。

如果你的贡献是大或如果你喜欢你自己的电脑上工作,继续阅读本指南学习另一种方法来将请求发送到Symfony文档。欧宝体育电话欧宝娱乐app下载地址

你的第一个文档的贡献欧宝体育电话

在本节中,您将学习如何导致首次Symfony的文档。欧宝体育电话欧宝娱乐app下载地址下一节将解释短流程你将来会跟每一个贡献后你的第一个。

假设你想提高安装指南。为了使您的更改,请执行以下步骤:

步骤1。Symfony官方文档存储库位于欧宝体育电话欧宝娱乐app下载地址github.com/欧宝娱乐app下载地址symfony/symfony-docs,然后点击叉按钮叉存储库你的个人账户。这是只需要你第一次Symfony。欧宝娱乐app下载地址

步骤2。克隆分叉的存储库到您的本地机器(本例中使用项目/ symfo欧宝娱乐app下载地址ny-docs /目录存储文档;欧宝体育电话相应改变这个值):

1 2

美元cd项目/美元git克隆git: / /github.com/YOUR-GITHUB-USERNAM欧宝娱乐app下载地址E/symfony-docs.git

步骤3。添加原Symfony文档库作为“G欧宝娱乐app下载地址it远程执行这个命令:

1 2

美元cd欧宝娱乐app下载地址symfony-docs /美元git远程上游添加https://github.com/symfony/symfony欧宝娱乐app下载地址-docs.git

如果一切顺利,您将看到以下当清单项目的“遥控器”:

1 2 3 4 5

美元git远程- v起源git@github.com: YOUR-GITHUB-USERNAME / symfony-欧宝娱乐app下载地址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官方库和自己的叉。欧宝娱乐app下载地址你会看到在行动。

步骤4。创建一个专门的新分支为你改变。使用一个短暂而难忘的分公司的名称(如果你解决报告问题,使用fix_XXX作为分公司名称,XXX是这个问题的数量):

1

美元git checkout - b improve_install_article上游/ 4.4

在这个例子中,分支机构的名称improve_install_article和上游/ 4.4值告诉Git的基础上创建这个分支4.4分支的上游远程,这是最初的Symfony文档存储库。欧宝娱乐app下载地址

应该根据修复古老的维护分支它包含错误。现在这是4.4分支。如果你不是记录一个新的功能,切换到第一个Symfony版本,包括,例如:欧宝娱乐app下载地址上游/ 3.1。

第5步。现在让你的文档的变化。欧宝体育电话添加、调整、改写甚至删除任何内容和尽力遵守欧宝体育电话文档标准。然后提交你的变化!

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/欧宝娱乐app下载地址symfony-docs,然后点击把请求链接位于侧边栏。

然后,点击大新的拉请求按钮。GitHub不能猜的变化,你想建议,选择适当的分支,变化应该被应用:

在这个例子中,基地叉应该是欧宝娱乐app下载地址symfony / symfony-docs和基地部门应该4.4,这是你选择的分支基地你的变化。的头叉应该是你的份吗欧宝娱乐app下载地址symfony-docs和比较分支机构应improve_install_article的名字,这是您创建的分支,你让您的更改。

步骤8。最后一步是准备描述拉的请求。短词或段落描述拟议中的变化足以确保可以回顾你的贡献。

第9步。现在您已经成功提交你的第一个贡献Symfony的文档,欧宝体育电话欧宝娱乐app下载地址去庆祝!文档管理欧宝体育电话人员将仔细审查你的工作在短时间内,他们会让你知道任何需要改变。

如果你被要求添加或修改,不创建一个新的请求。相反,确保你在正确的分支,使你改变和推动新变化:

1 2 3 4 5 6

美元cd项目/ symfo欧宝娱乐app下载地址ny-docs /美元git checkout improve_install_article#……你的变化美元git推

第10步。拉请求最终接受,合并后在Symfony的文档,你将被包含在欧宝体育电话欧宝娱乐app下载地址欧宝娱乐app下载地址Symfony文欧宝体育电话档贡献者列表。此外,如果你碰巧有一个欧宝娱乐app下载地址SymfonyConnect配置文件,你会得到一个酷欧宝娱乐app下载地址Symfony文欧宝体育电话档徽章。

你的下一个文档的贡献欧宝体育电话

看看你!你已经做出了你的第一个贡献Symfony文档!欧宝体育电话欧宝娱乐app下载地址有人抛出一个聚会!你的第一个贡献了一点额外的时间,因为你需要学习一些标准和设置你的电脑。但是从现在开始,你的贡献将会更容易完成。

这是一个检查表通过你的下一个步骤将指导您的贡献Symfony文档:欧宝娱乐app下载地址

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

#创建一个新的分支基于最古老的维护版本美元cd项目/ symfo欧宝娱乐app下载地址ny-docs /美元git获取上游美元git checkout - b my_changes上游/ 4.4#……你的变化#(可选)如果这是一个新内容添加您的更改美元git添加xxx.rst#提交您的更改并推动你的叉子美元git commit xxx.rst美元git push my_changes起源#……去GitHub创建请求#(可选)修改评论家和提交请求的美元git commit xxx.rst美元git推

在完成你的下一个贡献,也看你的排名提高的列表欧宝娱乐app下载地址Symfony文欧宝体育电话档贡献者。你猜对的:毕竟这艰苦的工作,它是时间再次庆祝!

回顾你的变化

每一个GitHub拉请求自动构建和部署欧宝娱乐app欧宝体育应用最新版app下载下载地址SymfonyCloud在一个环境,你可以在你的浏览器访问审核您的更改。

访问欧宝娱乐app欧宝体育应用最新版app下载下载地址SymfonyCloud环境URL,在GitHub上去拉请求页面,点击显示所有检查最后,点击上面的链接细节链接显示SymfonyCloud服务。欧宝娱乐app下载地址欧宝体育应用最新版app下载

1 2 3 4 5 6

#构建形象……美元码头工人。- t欧宝娱乐app下载地址 symfony-docs#……和start the local web server#(如果它已经在使用,改变了“8080”端口以其他端口)美元码头工人运行——rm - p 8080:80 symf欧宝娱乐app下载地址ony-docs

常见问题