对文档的贡献欧宝体育电话

欧宝娱乐app下载地址Symfony 5.3支持经过JoliCode

对文档的贡献欧宝体育电话

在您的第一次贡献之前

之前的贡献,你需要:

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

快速在线贡献

如果你正在做一个相对较小的改变——比如修复一个拼写错误或重新措辞——最简单的方式是直接在GitHub上做出贡献!您可以在阅读Symfony文档时执行此操作。欧宝体育电话欧宝娱乐app下载地址

步骤1。点击编辑该页面按钮,你会被重定向到GitHub:

. . / . . / _images / docs-github-edit-page.png

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

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

. . / . . / _images / docs-github-create-pr.png

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

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

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

如果您的贡献大或如果您愿意在自己的计算机上工作,请继续阅读本指南,以学习向Symfony文档发送拉出请求的替代方法。欧宝体育电话欧宝娱乐app下载地址

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

在本节中,您将学习如何第一次为Symfony文档做出贡献。欧宝体育电话欧宝娱乐app下载地址下一节将解释您将来在您的第一个之后的每一项贡献都会遵循更短的过程。

让我们想象您要改进设置指南。要进行更改,请按照下列步骤操作:

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

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

1 2
$光盘项目/$git克隆git: / / github.com/YOUR-GITHUB-USERNAME/sy欧宝娱乐app下载地址mfony-docs.git

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

1 2
$光盘欧宝娱乐app下载地址symfony-docs /$git远程添加上游https://github.com/symfony/symfony欧宝娱乐app下载地址-docs.git

如果事情正确,您将在列出项目的“Remotes”时,您将看到以下内容:

1 2 3 4 5
$git remote - v起源(电子邮件保护):您的github-username / s欧宝娱乐app下载地址ymfony-docs.git(获取)起源(电子邮件保护):您的github-username / s欧宝娱乐app下载地址ymfony-docs.git(推送)上游https://github.com/symfony欧宝娱乐app下载地址/symfony-docs.git(获取)上游https://github.com/symfony欧宝娱乐app下载地址/symfony-docs.git(推)

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

1
$git上游提取

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

步骤4。创建一个专门的新分支为你改变。为新分支使用一个简短且容易记住的名称(如果您正在修复报告的问题,请使用fix_XXX作为分支名称,在哪里XXX是问题的数量):

1
$Git checkout -b improve_install_article upstream/4.4

在此示例中,分支的名称是Requent_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 origin inform_install_article

起源value是与您的分叉存储库相对应的Git远程的名称Requent_install_Article.是您之前创建的分支的名称。

步骤7。现在一切都准备好了拉请求.转到你的叉子存储库https://github.com/your-github-username/欧宝娱乐app下载地址symfony-docs.然后点击把请求链接位于侧边栏中。

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

. . / . . / _images / docs-pull-request-change-base.png

在本例中基叉应该是欧宝娱乐app下载地址symfony / symfony-docs基地分支应该是4.4,这是您选择基于更改的分支。这头叉应该是你的分叉副本欧宝娱乐app下载地址symfony-docs比较分支机构应Requent_install_Article.,它是您创建的分支的名称以及您进行更改的位置。

步骤8。最后一步是准备描述拉出请求。描述所提出的变更的短语或段落足以确保您可以审核您的贡献。

第9步。既然您已经成功地向Symfony文档提交了您的第一个贡献,欧宝体育电话欧宝娱乐app下载地址去庆祝!文档管理欧宝体育电话员会在短时间内仔细检查您的工作,并让您知道任何需要的更改。

如果你被要求添加或修改一些东西,不要创建一个新的pull请求。相反,要确保你在正确的分支上,做出你的更改并推动新的更改:

1 2 3 4 5 6
$光盘项目/ symfo欧宝娱乐app下载地址ny-docs /$git checkout charment_install_article.#......做你的变化$git推

第10步。在Symfony文档中最终接受并合并您的pull请求后,您将被包括在欧宝体育电话欧宝娱乐app下载地址欧宝娱乐app下载地址Symfony文欧宝体育电话档贡献者列表。而且,如果你碰巧有欧宝娱乐app下载地址SymfonyConnect侧写,你会得到一份清凉欧宝娱乐app下载地址Symfony文欧宝体育电话档徽章

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

看看你!您已经对Symfony文档做出了您的第一个贡献!欧宝体育电话欧宝娱乐app下载地址谁来办个派对!您的第一个贡献花了一点额外的时间,因为您需要学习一些标准和设置您的计算机。但从现在开始,你的贡献会更容易完成。

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

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
#基于最旧的维护版本创建一个新分支$光盘项目/ symfo欧宝娱乐app下载地址ny-docs /$git上游提取$Git checkout -b my_changes上游/4.4#......做你的变化#(可选)添加您的更改,如果这是一个新内容$git添加xxx.rst#提交更改并将它们推到叉子上$git commit xxx.rst$Git push origin my_changes#……去GitHub并创建Pull Request#(可选)进行评论者请求的更改并提交它们$git commit xxx.rst$git推

在完成你的下一个贡献后,也可以看到你的排名在列表上的改善欧宝娱乐app下载地址Symfony文欧宝体育电话档贡献者.你猜对了,经过这么多努力,它是时候再次庆祝了!

回顾你的变化

每个GitHub Pull Request自动构建和部署欧宝娱乐app欧宝体育应用最新版app下载下载地址SymfonyCloud在您可以在浏览器上访问的单个环境中查看您的更改。

欧宝娱乐app欧宝体育应用最新版app下载下载地址SymfonyCloud Pull Request部署

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

笔记

只有对维护分支的Pull request才会被SymfonyCloud自动构建。欧宝娱乐app下载地址欧宝体育应用最新版app下载检查路线图为维护分支。

本地构建文档欧宝体育电话

如果您的计算机上安装了Docker,请运行这些命令以构建文档:

1 2 3 4 5 6
# build the image…$码头工人。- t欧宝娱乐app下载地址 symfony-docs#...并启动本地Web服务器#(如果它已经被使用,更改'8080'端口的任何其他端口)$运行——rm -p8080: 80欧宝娱乐app下载地址 symfony-docs

您现在可以阅读文档http://127.0.0.1:8080(如果你使用虚拟机,浏览它的IP而不是localhost;如。http://192.168.99.100:8080)。

如果您不使用Docker,请按照以下步骤在本地构建文档:

  1. 安装皮普pip安装文章;

  2. 安装斯芬克斯PHP和Symfony的狮身人面像延伸欧宝娱乐app下载地址(根据你的系统,你可能需要以root用户的身份执行这个命令):

    1 2
    $光盘_build /$PIP安装-r .requirements.txt
  3. 运行以下命令以HTML格式构建文档:欧宝体育电话

    1 2
    $光盘_build /$使html

生成的文档可以在欧宝体育电话_build / html目录中。

常见问题

为什么我的变化需要核查和/或合并

请耐心等待。可以完全审查您的拉出请求之前需要几天时间。合并更改后,它可能在您的更改出现在Symfony网站上的更改前几个小时。欧宝娱乐app下载地址

为什么我应该使用最老的维护分支而不是最新的分支?

与Symfony的源代码一致,文欧宝娱乐app下载地址档存储库被拆分为多个分支,对应于Symfony本身的不欧宝体育电话同版本。最新的(如。5.x.)分支持有代码开发分支的文档。欧宝体育电话

除非你是在记录Symfony 4.4之后引入的特性,否则你的更改应该总是基于欧宝娱乐app下载地址4.4分支。欧宝体育电话文档管理器将使用必要的Git-magic将您的更改应用到文档的所有活动分支。

如果我想在没有完全完成的情况下提交我的工作怎么办?

你可以的。但请使用这两个前缀之一,让评审者了解您的工作状态:

  • (在制品)(Work in Progress)用于当你还没有完成你的pull request,但你希望它被审查。pull request不会被合并,直到你说它准备好了。
  • (WCM)(等待代码合并)在您记录尚未接受核心代码的新功能或更改时使用。在核心代码中合并到核心代码中,不会合并拉出请求(如果拒绝更改)。

你会接受一个有很多变化的巨大拉请求吗?

首先,确保更改有些相关。否则,请创建单独的拉动请求。无论如何,在提交巨大的变化之前,在Symfony文档存储库中打开一个问题可能是一个好主意,以便如果他们同意拟议的变更,请询问管理人员。欧宝体育电话欧宝娱乐app下载地址否则,他们可以在将所有努力造成更改后拒绝您的提议。我们绝对不希望你浪费你的时间!

这项工作,包括代码样本,是在一个Creative Commons by-SA 3.0执照。