如何为PHP贡献你的源代码 参与PHP社区建设的步骤

PHP在之前把源代码迁移到了git下管理, 同时也在github(https://github.com/php/php-src)上做了镜像, 这样一来, 就方便了更多的开发者为PHP来贡献代码.

今天写这篇文章, 就是为了给在国内的同学们, 愿意为PHP开源社区做贡献的同学们, 做个示例, 如何为PHP来贡献你的智慧.

现在, 假设你要为贡献一个新特性, 那么你除了要做下面的这些步骤以外, 还需要在wiki.php.net上提交一个RFC, 待会我会介绍这个, 现在让我们先简单点, 假设你只是要为PHP修复一个bug(一般来说, 大家可以在这里发现PHP已经报告的bug: PHP Bugs).

现在假设你已经想好了要怎么修复这个Bug.

1. 注册github, 你需要有一个github的账号, 没有的话, 先注册;

2. Fork PHP的源代码, 在PHP的Github页面上的右上角有一个fork按钮, 点它

3. 拥有自己的PHP源代码仓库, 现在你就可以在这个仓库下, 修改PHP的源代码来为它修复Bug了.

我这里为大家提供一个简单的说明, 如果在Github上开始开发, 在你自己的PHP代码仓库的页面上, 会有一个说明, 比如在我的PHP仓库页面上https://github.com/laruence/php-src:

ssh git@github.com:laruence/php-src.git

然后, 我就在本地开发环境上, 执行:

$git clone git@github.com:laruence/php-src.git

然后, 你就得到了一个php-src目录, 进去开发吧。

4. 优化代码提交到自己的PHP仓库中,  在你的PHP源代码仓库的Github页面的右上角, 会有一个pull request按钮. 点它.

提交的时候, 请注意你的提交说明的格式, 首先第一行应该是个简短的说明(最多79个字符), 说明你做了什么修改. 如果一句话说不完, 就插入一个空行, 然后输入大段的说明(参看New Commit Message Format) :

‹max 79 characters short description>\n
\n
‹long description, 79 chars per line>
\n

如果你是修复了一个列在bugs.php.net上的bug, 那么你的简短说明应该类似如下格式:

Fixed Bug #bug号 (Bug的描述)

5. 填写Pull Request邮件相关的信息, Github就会给PHP的pull request邮件组发送一份包含着你的更新的Pull Request邮件(大家不用担心你的英文, 只要你能说出来, 我们就能看懂, 当然, 如果你实在不愿意写英文, 也没关系, 写中文吧, 我看到了会处理, 我处理不了的, 我也会为大家翻译).

6. PHP的Committers们确认修复,就会Merge你的Pull Request到PHP的源代码中.

现在, 假设你要提交的是, 一个更新(添加新函数, 添加新语法), 那么在你提交了Pull Request的同时, 你还需要往internals@lists.php.net邮件组发送一个邮件, 来说明你为什么要提交这个更新, 让在这个邮件组的人们一起来讨论, 帮助你完善你的想法.

最后, 在你为PHP贡献了一些更新以后(被Committer接受的更新), 那么你就可以尝试在: Register Svn Accout上来申请一个你自己的PHP Developer账号了.

附录:

为PHP贡献源代码有几点要注意的(常见的问题):

1、只写C89兼容的代码, 比如, 不要用单行注释(//), 变量的定义一定要在所有语句之前(block的开始)..
2、变量命名, 遵循PHP已有的规范, 不要使用驼峰命名.
3、对于一些非常小的更新, 比如代码中有拼写错误, 还是鼓励大家到bugs.php.net上提交Patch, 毕竟Merge Pull Request有的时候会比较麻烦.

更多的PHP代码规范, 参看这里: Submitting patch

https://github.com/php/php-src/blob/master/README.SUBMITTING_PATCH

转载请注明出处:https://www.onexin.net/php-src/

相关文章:

1、用 PHP 编写更好的正则表达式regex
https://www.onexin.net/php-regex/

2、PHP 版本 8.2,8.1,8.0,7.4
https://www.onexin.net/php-8_2-8_1-8_0-7_4/

3、PHP中的Liskov替换原则
https://www.onexin.net/php-liskov/

4、php实现自运行的do实例详解
https://www.onexin.net/php-do/

5、PHP 后端实现JWT认证方法示例
https://www.onexin.net/php-jwt/

Leave a Reply