首页 > 后端开发 > php教程 > 为PHP做出贡献:如何为PHP贡献手册

为PHP做出贡献:如何为PHP贡献手册

Joseph Gordon-Levitt
发布: 2025-02-15 12:25:12
原创
808 人浏览过

这个分为两部分的系列探讨了如何为PHP项目做出贡献,重点是第一部分的文档。 我们将介绍帐户请求和批准后步骤。

Contributing to PHP: How to Contribute to PHP's Manual

密钥点:

  • 为PHP的文档做出贡献,可以增强语言并提高您的PHP专业知识。它还可以导致php.net帐户,从而影响语言的方向。
  • >文档使用docbook xml;熟悉是有用的,但不是强制性的。
  • >
  • 初学者可以将在线编辑器用于简单补丁。 建议事先审查样式指南。
  • >频繁的贡献者或需要大量编辑的人应在本地设置文档并请求php.net帐户。这涉及创建一个目录,克隆文档和配置SVN关键字。
  • >
  • 贡献包括错误修复,翻译,扩展现有内容,记录无证功能和一般改进。
  • >
为什么要贡献? php是开源的,在社区参与方面蓬勃发展。 增加的参与使每个人都受益。无论是改进文档,修复错误还是添加功能,每个贡献都很重要。 积极参与加深您的PHP知识,并允许您请求PHP.NET帐户,塑造该语言的未来。

了解PHP的文档

文档在DocBook XML中。 先验知识并非严格必要; XML语法很容易学习。

> 目录结构是:

>包含用于转换XML文档的工具。

保存英语文档(其他语言使用其两行代码)。 Contributing to PHP: How to Contribute to PHP's Manual >包含特定于扩展的目录(程序扩展的功能,以对象为导向的文件夹的命名文件夹)。 每个扩展文件夹都包含

(登录页面)和

(版本化信息)。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帐户。

创建
    目录。
  1. > phpdocs>使用SVN克隆文档:
  2. > svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en>克隆PHD(渲染工具):
  3. > git clone http://git.php.net/repository/phd.git>克隆php.net网站:
  4. ;删除
  5. 并创建指向渲染文档的符号链接。 git clone http://git.php.net/repository/web/php.git web-phpweb-php/manual/en中的svn关键字:
  6. ~/.subversion/config *.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL(可选)创建一个
  7. 文件,并在本地使用命令进行验证,构建和查看文档。
  8. > ref
docs workflow(local)

设置后,更新存储库(

)。 编辑相关的XML文件,使用svn up进行验证,使用PHD构建,然后启动本地服务器。 使用svn(git pull,引用错误号码)提交更改。在更改传播后,从“开发人员”选项卡中关闭错误报告。php ~/phpdocs/doc-en/doc-base/configure.phpsvn ci -m "Resolve doc bug #...")

请求php.net帐户

> 本地设置后,请求使用DOCS KARMA的PHP.NET帐户。 尽管不存在严格的先决条件,但表现积极的贡献是关键。 提交帐户请求表并发送电子邮件至phpdoc@lists.php.net,以解释您的意图,Wiki用户名和过去的贡献。

>文档任务

超越错误修复:

translations
  • >扩展部分记录的材料
  • 记录无证件的功能
  • 一般改进
一般提示

遵循样式指南。
  • 修复错误时检查相关方面。
  • >简洁地写。
  • >与输出单独的示例代码。
  • 确保正确的页面订单。
  • 删除php 4参考。
  • 正确版本的新文件。
  • >请咨询文档常见问题解答或php-docs邮件列表以寻求帮助。
  • 结论

>该部分涵盖了两个工作流程:在线编辑和本地设置。第二部分将涵盖PHP核心的贡献。

>

> FAQS

(移动到末端以获得更好的流)
  • > 贡献过程:>创建一个帐户,编辑/创建内容,翻译,遵循指南。
  • 贡献的重要性:提高文档质量,保持最新状态,促进社区。
  • >
  • 确保接受:遵循指南,确保准确性和清晰度,获得反馈。
  • 非母语英语的人:欢迎贡献;翻译是一个有价值的贡献。
  • 常见错误:不遵循准则,不准确/不清楚的信息,缺乏校对,不必要的更改。
  • 获得帮助:
  • 使用在线论坛,讨论组,文档指南。 >
  • 匿名贡献:
  • 可能会鼓励帐户。 贡献频率:
  • 根据可用性和兴趣而变化。
  • 薪酬:通常志愿者工作。
  • >
  • 报告错误:如果贡献者,请纠正它们,否则向社区报告。
  • 记住用实际的图像URL替换占位符图像URL。 我保留了图像格式,并根据要求将图像保持在其原始位置。>

以上是为PHP做出贡献:如何为PHP贡献手册的详细内容。更多信息请关注PHP中文网其他相关文章!

本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板