对于新的贡献,我们将强制执行编码标准,以确保源代码中的编码风格一致。确保您的代码符合这些标准将使代码贡献过程更加顺利。

配置代码分析工具

为了提高源代码的一致性和可读性,Joomla 项目在将更改推送到 Joomla 项目的存储库时,运行编码样式分析工具 PHP_CodeSniffer。

运行 PHP_CodeSniffer

Joomla 编码标准嗅探器规则被编写为与名为 PHP CodeSniffer 的工具一起使用。请参见 PHP_CodeSniffer PEAR 页面,了解有关在您的系统上安装 PHP_CodeSniffer 的信息。

您可以通过转到 CMS、框架或问题跟踪器的根目录并执行以下操作来运行 CodeSniffer

phpcs --report=checkstyle --report-file=build/logs/checkstyle.xml --standard=/path/to/<your root>/build/phpcs/Joomla /path/to/<your root>

或者,如果您在系统上安装了 Ant,您可以通过转到您要测试的 Joomla 项目代码的 <root directory> 并执行以下操作来运行 CodeSniffer

ant phpcs

其他工具

以下是一些可供计划向项目提交源代码的开发人员使用的其他工具。

设置 PHP_CodeSniffer

请参阅文档 https://docs.joomla.org/Joomla_CodeSniffer#3._IDE_Integration