在你第一次捐款之前

之前的贡献，你应考虑以下因素:

• ob娱乐下载Symfony文欧宝官网下载app档是使用reStructuredText标记语言。如果你不熟悉这种格式，请阅读这篇文章以快速概述其基本功能。
• ob娱乐下载Symfony文欧宝官网下载app档托管在GitHub．您需要一个GitHub用户帐户来编写文档。欧宝官网下载app
• ob娱乐下载Symfony文欧宝官网下载app档是在创作共用BY-SA 3.0许可协议你所有的贡献都将隐含地遵守这个许可。

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

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

让我们假设您想要改进Symfony书籍的安装章节。ob娱乐下载为了进行更改，请遵循以下步骤:

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

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

1 2

＄cd项目/ $ git克隆git://github.com/<你的GITHUB用户名>/symfony-dob娱乐下载ocs.git

步骤3。切换到最古老的分支在做出任何改变之前。现在这是2．3分支机构:

1 2

＄cdob娱乐下载Symfony-docs / $ git签出2.3

如果你正在记录一个新特性，请切换到包含它的第一个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用户名>/symfony-dob娱乐下载ocs然后点击把请求链接位于侧栏。

然后，点击大的新的拉请求按钮。由于GitHub无法猜测您想要提出的确切更改，请选择应应用更改的适当分支:º

在本例中，基础库应该是ob娱乐下载symfony / symfony-docs和基地分支应该是2．3，这是您所选择的更改所基于的分支。的比较库应该是你的分叉副本吗ob娱乐下载symfony-docs和比较分支应该是improve_install_chapter，这是您创建的分支的名称，也是您进行更改的位置。

步骤8。最后一步是准备描述的拉请求。为了确保您的工作被快速审查，请在您的拉请求描述的开头添加下表:

1 2 3 4 5 6

| Q | A | ------------- |—| Doc fix?|[是|否]|新文档?| [yes|no] (symfony/ob娱乐下载symfony上的PR号，如果适用)|适用于| [symfony版本号，适用于]|固定门票|[由PR固定的门票列表，以逗号分隔]

在这个例子中，这个表看起来如下所示:

1 2 3 4 5 6

| Q | A | ------------- |—| Doc fix?|是|新医生?| no |适用于|所有|固定票| #10575

第9步。现在您已经成功地向Symfony文档提交了您的第一个贡献，欧宝官网下载appob娱乐下载去庆祝吧!文档管理欧宝官网下载app人员将在短时间内仔细检查您的工作，并让您知道任何需要更改的地方。

如果您需要添加或修改任何内容，则不需要创建新的pull请求。只要确保你在正确的分支上，做出你的更改并推送它们:

1 2 3 4 5 6

＄cdProjects ob娱乐下载/ symfy -docs/ $ git checkout improve_install_chapter#……做你的改变$ git推送

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

第二份文档贡献欧宝官网下载app

第一个贡献花了一些时间，因为您必须分叉存储库，学习如何编写文档，遵守拉请求标准，等等。欧宝官网下载app第二个贡献要简单得多，除了一个细节:鉴于Symfony文档存储库的激烈更新活动，您的分支现在很可能已经与官方存储库过时了。欧宝官网下载appob娱乐下载

解决这个问题需要你同步你的叉子使用原始存储库。要做到这一点，首先执行这个命令告诉git原始的存储库:

1 2

＄cd项目/symfonob娱乐下载y-docs/ $ git远程添加上游https://github.com/symfony/symfony-docs.git

现在你可以同步你的叉子执行如下命令:

1 2 3 4

＄cd项目/symfonob娱乐下载y-docs/ $ git获取上游$ git checkout 2.3 $ git合并上游/2.3

该命令将更新2．3分支，这是您用来为更改创建新分支的一个分支。如果使用了另一个基本分支，例如。主，替换2．3使用适当的分支名称。

太棒了!现在你可以按照前一节中解释的步骤继续:

12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20 21

#创建一个新的分支来存储基于2.3分支的更改＄cd项目/symfonob娱乐下载y-docs/ $ git checkout 2.3 $ git checkout -b my_changes#……做你的改变#提交更改到您的fork存储库$ git添加xxx.rst#(可选)仅当这是一个新内容$ git提交xxx。RST $ git推送#转到GitHub并创建Pull Request＃#在描述中包含这个表:# | q | a# | ------------- |——# |文件修复?|(是的|不)# |新文档?|[是|否](symfony/symfoob娱乐下载ny上的PR号，如果适用)# |适用于| [Symfony版本ob娱乐下载号适用于]# |固定门票|[由PR固定的门票列表，以逗号分隔]

你的第二个贡献现在完成了，所以再次庆祝吧!的列表中还可以看到您的排名如何提高ob娱乐下载Symfony文欧宝官网下载app档贡献者．

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

现在您已经对Symfony文档做出了两次贡献，您可能已经熟悉了这个过程中涉及的所有git魔术ob娱乐下载。欧宝官网下载app这就是为什么你下一次的贡献会快得多。在这里，您可以找到创建Symfony文档的完整步骤，您可以将其用作欧宝官网下载appob娱乐下载检查表：

12 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

#同步你的fork与官方Symfony仓库ob娱乐下载＄cd项目/symfonob娱乐下载y-docs/ $ git获取上游$ git checkout 2.3 $ git合并上游/2.3#从最老的维护版本创建一个新分支$ git checkout -b my_changes#……做你的改变#添加并提交您的更改$ git添加xxx.rst#(可选)仅当这是一个新内容$ git提交xxx。RST $ git推送#转到GitHub并创建Pull Request＃#在描述中包含这个表:# | q | a# | ------------- |——# |文件修复?|(是的|不)# |新文档?|[是|否](symfony/symfoob娱乐下载ny上的PR号，如果适用)# |适用于| [Symfony版本ob娱乐下载号适用于]# |固定门票|[由PR固定的门票列表，以逗号分隔]#(可选的)做出审稿人要求的更改并提交它们$ git提交xxx。RST $ git推送

你猜对了，辛苦工作之后，它又到了庆祝的时候了!

常见问题