在你第一次捐款之前

之前的贡献，你需要:

• 注册一个免费的GitHub帐户，它是托管Symfony文档的服务。欧宝官网下载appob娱乐下载
• 熟悉reStructuredText标记语言，用于编写Symfony文档。ob娱乐下载读这篇文章快速概述。

快速在线捐款

如果你做了一个相对较小的改变——比如修复一个错别字或重新措辞——最简单的贡献方式是直接在GitHub上!您可以在阅读Symfony文档时进行此操作。欧宝官网下载appob娱乐下载

步骤1。点击编辑本页按钮在右上角，你会重定向到GitHub:

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

步骤3。GitHub现在将为你的更改创建一个分支和一个提交(如果这是你的第一个贡献，则首先分叉存储库)，它还将显示你的更改的预览:

如果一切正确，单击创建拉请求按钮。

步骤4。GitHub将显示一个新页面，您可以在创建它之前对您的拉请求进行一些最后的更改。对于简单的贡献，您可以安全地忽略这些选项，只需单击创建拉请求按钮一次。

恭喜你!您刚刚创建了一个对官方Symfony文档的pull请求!欧宝官网下载appob娱乐下载社区现在欧宝体育平台怎么样将审查你的拉请求，并(可能)建议调整。

如果您的贡献很大，或者您更喜欢在自己的计算机上工作，请继续阅读本指南，学习向Symfony Documentation发送pull请求的另一种方法。欧宝官网下载appob娱乐下载

你的第一份文档贡献欧宝官网下载app

在本节中，您将学习如何首次为Symfony文档做出贡献。欧宝官网下载appob娱乐下载下一节将解释在您的第一个贡献之后，您将遵循的更短的过程。

让我们假设您想要改进安装指南。为了进行更改，请遵循以下步骤:

步骤1。转到Symfony官方文档存储库，位于ob娱乐下载欧宝官网下载appgithub.com/ob娱乐下载symfony/symfony-docs然后点击叉按钮Fork存储库转到你的个人账户。这只在您第一次向Symfony做出贡献时才需要。ob娱乐下载

步骤2。克隆分支存储库到本地机器(本例使用项目/ symfoob娱乐下载ny-docs /存储文档的目录;欧宝官网下载app相应地更改此值):

1 2

＄cd项目/＄git克隆git@github.com: YOUR-GITHUB-USERNAMEob娱乐下载 / symfony-docs.git

步骤3。添加原来的Symfony文档存储库ob娱乐下载作为“Git远程”执行以下命令:

1 2

＄cdob娱乐下载symfony-docs /＄Git远程添加上游https://github.com/symfony/symfonyob娱乐下载-docs.git

如果一切顺利，在列出项目的“remotes”时，你会看到以下内容:

1 2 3 4 5

＄git remote -v origin git@github.com:YOUR-GITHUB-USERNAME/ob娱乐下载symfony-docs.git(获取)origin git@github.com:YOUR-GITHUB-USERNAME/symfony-docs.git(推送)upstream https://github.com/symfony/symfony-docs.git(获取)upstream https://github.com/symfony/symfony-docs.git(推送)

通过执行以下命令获取上游分支的所有提交:

1

＄Git上游获取

这一步的目的是允许您同时在官方Symfony存储库和您自己的分支上工作。ob娱乐下载稍后您将看到它的实际应用。

步骤4。创建一个专用的新分支用于您的更改。为新分支使用一个简短且容易记住的名称(如果您正在修复报告的问题，请使用fix_XXX作为分支名称，其中XXX是发行号):

1

＄Git checkout -b improve_install_article upstream/5.4

在本例中，分支的名称为improve_install_article和上游/ 5.4值告诉Git基于5.4的分支上游这是最初的Symfony Docs存储库。ob娱乐下载

修复应始终基于最古老的分支其中包含错误。现在这是5.4分支。如果您正在记录一个新特性，请切换到包含它的第一个Symfony版本。ob娱乐下载上游/ 6.2．

第5步。现在在文档中进行更改。欧宝官网下载app添加，调整，改写，甚至删除任何内容，尽你最大的努力遵守欧宝官网下载app文档标准．然后提交您的更改!

1 2 3

如果修改的内容之前已经存在＄Git添加setup.rst＄Git提交setup.rst

步骤6。推对分叉存储库的更改:

1

＄Git推送源码improve_install_article

的起源value是对应于派生存储库的Git远程的名称improve_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人员将在短时间内仔细检查您的工作，并让您知道任何需要更改的地方。

如果您被要求添加或修改某些内容，请不要创建新的pull请求。相反，确保你在正确的分支上，做出你的更改并推送新的更改:

1 2 3 4 5 6

＄cd项目/ symfoob娱乐下载ny-docs /＄Git签出improve_install_article#……做你的改变＄git推

第10步。在您的pull请求最终被接受并合并到Symfony文档之后，您将被包含在欧宝官网下载appob娱乐下载ob娱乐下载Symfony文欧宝官网下载app档贡献者列表。此外，如果你碰巧有一个ob娱乐下载SymfonyConnect侧面，你会得到一份清凉ob娱乐下载Symfony文欧宝官网下载app档徽章．

您的下一个文档贡献欧宝官网下载app

看看你!您已经对Symfony文档做出了第一次贡献!欧宝官网下载appob娱乐下载谁来办个派对!你的第一个贡献花了一点额外的时间，因为你必须学习一些标准和设置你的计算机。但从现在开始，你的贡献会更容易完成。

这是一个检查表这些步骤将指导您完成对Symfony文档的下一个贡献:ob娱乐下载

12 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 upstream/5.4#……做你的改变#(可选)添加您的更改，如果这是一个新的内容＄Git添加xxx.rst#提交您的更改并将它们推到您的fork＄Git提交xxx.rst＄Git推送源my_changes#……去GitHub并创建Pull Request#(可选的)做出审稿人要求的更改并提交它们＄Git提交xxx.rst＄git推

完成您的下一个贡献后，还可以查看您在列表中的排名提高ob娱乐下载Symfony文欧宝官网下载app档贡献者．你猜对了，辛苦工作之后，它又到了庆祝的时候了!

检查您的更改

ob娱乐下载Symfony存储库会自动检查每个Pull Request，以查找代码块中的常见错误、不恰当的单词、语法问题等。

您还可以在本地计算机中构建文档，以调试问题或脱机阅读文档。欧宝官网下载app要做到这一点，请遵循symfony-docs仓库的READob娱乐下载ME文件．

常见问题