贡献文档欧宝官网下载app
编辑本页警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 2.0,现已不再维护。
读本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。
贡献文档欧宝官网下载app
欧宝官网下载app文档和代码一样重要。它遵循完全相同的原则:DRY、测试、易于维护、可扩展性、优化和重构等等。当然,文档也有bug、错别字、欧宝官网下载app难以阅读的教程等等。
贡献
在进行贡献之前,您需要熟悉标记语言文档使用。欧宝官网下载app
Symfob娱乐下载ony2文档托管在欧宝官网下载appGitHub上:
1
https://github.com/ob娱乐下载symfony/symfony-docs
如果你想提交补丁,叉GitHub上的官方存储库,然后克隆你的fork:
1
git美元克隆git: / / github.com/YOURUSERNAob娱乐下载ME/symfony-docs.git
与Symfony的源代码一致,文ob娱乐下载档存储库被划分为多个分支:欧宝官网下载app2.0
,2.1
,2.2
对应于Symfony本身的不同版本。ob娱乐下载的主
分支保存代码的开发分支的文档。欧宝官网下载app
除非您正在记录引入的特性后ob娱乐下载Symfony 2.0(例如在Symfony 2.1中),您的更改应该始终基于2.0分支。要做到这一点,在下一步之前签出2.0分支:
1
$ git结帐2.0
提示
的基本分支(例如2.0)将成为“适用于”贡献文档欧宝官网下载app你以后会用到的。
接下来,为你的变更(组织)创建一个专用的分支:
1
$ git checkout -b improing_foo_and_bar
您现在可以直接对这个分支进行更改并提交它们。做完之后,把这根树枝推到你的GitHub分叉并发起拉请求。
创建拉请求
按照这个示例,拉请求将默认为在您的improving_foo_and_bar
分支和ob娱乐下载symfony-docs
主
分支。
如果你已经基于2.0分支进行了更改,那么你需要在预览页面中将基础分支更改为2.0:
请注意
对分支(例如2.0)所做的所有更改将每周合并到每个“更新的”分支(例如2.1,master等),以用于下一个版本。
GitHub涵盖的主题把请求在细节。
请注意
Symfob娱乐下载ony2文档在创作欧宝官网下载app共用署名相似共享3.0未移植协议下授权使用许可证.
在某些情况下,你也可以在pull请求的标题前加上前缀:
(在制品)
(Work in Progress)用于还没有完成pull请求,但希望对其进行审查的情况。pull请求在您说它准备好之前不会被合并。(WCM)
(等待代码合并)用于记录尚未被核心代码接受的新特性或更改。pull请求在核心代码中被合并之前不会被合并(或者在更改被拒绝时关闭)。
拉请求格式
除非你在修复一些小的错别字,否则拉请求描述必须包括以下检查表,以确保您的贡献可以在没有不必要的反馈循环的情况下进行审查,并且您的贡献可以尽快包含到文档中:欧宝官网下载app
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?|是|新医生?| yes (ob娱乐下载symfony/symfony#2500) |适用于|所有(或2.1+)|固定票| #1075
提示
请耐心等待。在文档团队合并您的pull请求后,您的更改可能需要15分钟到几天才能出现在www.pdashmedia.com网站上。欧宝官网下载appob娱乐下载方法检查更改是否引入了一些标记问题欧宝官网下载app文档构建错误页面(它在每个法国之夜凌晨3点服务器重建文档时更新)。欧宝官网下载app
记录新特性或行为变化
如果您正在记录一个全新的特性或Symfony2中所做的更改,那么您应该在描述更改之前加上ob娱乐下载. .versionadded:: 2。X
标签和简短说明:
1 2 3 4
. .在Symfony 2.2中添加了askHiddenResponse方法。ob娱乐下载你也可以问一个问题,然后隐藏答案。这尤其……
如果你正在记录一个行为改变,它可能会有帮助短暂的描述行为是如何改变的。
1 2 3
. .include()函数是Symfony 2.2中新增的Twig特性。ob娱乐下载之前,使用了' ' {% include %} ' '标记。
每当Symfony2的一个新的小版本发布时(例如2.3、2.4等ob娱乐下载),文档的一个新分支就会从欧宝官网下载app主
分支。此时此刻,所有的versionadded
Symfony2版ob娱乐下载本的标签将被删除。例如,如果Symfony 2.5ob娱乐下载今天发布,而2.2最近已经走到了生命的尽头,那么2.2versionadded
标签将从新的2.5分支中移除。
标准
应该遵循欧宝官网下载appSymfony docuob娱乐下载mentation中的所有文档文档标准欧宝官网下载app.