这个分为两部分的系列探讨了如何为PHP项目做出贡献,重点是第一部分的文档。 我们将介绍帐户请求和批准后步骤。
密钥点:
了解PHP的文档
文档在DocBook XML中。 先验知识并非严格必要; XML语法很容易学习。
> 目录结构是:
>包含用于转换XML文档的工具。
保存英语文档(其他语言使用其两行代码)。 >包含特定于扩展的目录(程序扩展的功能,以对象为导向的文件夹的命名文件夹)。 每个扩展文件夹都包含
(版本化信息)。doc-base
en
该文档当前是基于SVN的(尽管迁移到Git)。 本地设置需要SVN熟悉。reference
book.xml
versions.xml
首次贡献者
首先使用在线文档编辑器。 这允许OAuth登录和提交简单的补丁。一致的帐户使用简化了未来php.net帐户应用程序的跟踪贡献。
在提交补丁之前熟悉样式准则。 >
>示例:解决错误#71716>此错误在示例中报告了错误的命名为MongoDB客户端类。验证后,使用在线编辑器纠正命名空间。
>嵌入视频:https://www.php.cn/link/14AA36297925D3C82891D74FA28D7DF1
local设置
在线编辑器有限;有关更大的贡献,请在本地设置文档并请求php.net帐户。创建
phpdocs
>使用SVN克隆文档:svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en
>克隆PHD(渲染工具):git clone http://git.php.net/repository/phd.git
>克隆php.net网站:git clone http://git.php.net/repository/web/php.git web-php
web-php/manual/en
中的svn关键字:~/.subversion/config
*.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
(可选)创建一个ref
设置后,更新存储库(
和)。 编辑相关的XML文件,使用svn up
进行验证,使用PHD构建,然后启动本地服务器。 使用svn(git pull
,引用错误号码)提交更改。在更改传播后,从“开发人员”选项卡中关闭错误报告。php ~/phpdocs/doc-en/doc-base/configure.php
。
svn ci -m "Resolve doc bug #...")
> 本地设置后,请求使用DOCS KARMA的PHP.NET帐户。 尽管不存在严格的先决条件,但表现积极的贡献是关键。 提交帐户请求表并发送电子邮件至phpdoc@lists.php.net,以解释您的意图,Wiki用户名和过去的贡献。
>文档任务超越错误修复:
translations
遵循样式指南。
>该部分涵盖了两个工作流程:在线编辑和本地设置。第二部分将涵盖PHP核心的贡献。
>> FAQS
(移动到末端以获得更好的流)以上是为PHP做出贡献:如何为PHP贡献手册的详细内容。更多信息请关注PHP中文网其他相关文章!