关于 woocommerce-backend-dev
面向 WooCommerce 后端 PHP 开发者的规范指南,涵盖代码结构、测试、钩子、依赖注入和数据完整性。
主要功能
- 01PHP 结构与命名指南
- 02WordPress 编码规范
- 03PHPDoc 与类型注解
- 04钩子与依赖注入
- 05CRUD 完整性与单元测试
适用场景
- 01添加 WooCommerce PHP 类
- 02修改后端代码或钩子
- 03编写 PHP 单元测试
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ woocommerce/ woocommerce --skill woocommerce-backend-dev安装后在 Claude Code 中输入/woocommerce-backend-dev确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
code-entities.mdcoding-conventions.mddata-integrity.mddependency-injection.mdfile-entities.mdhooks.mdtype-annotations.mdunit-tests.md详细介绍
WooCommerce 后端开发
本技能提供有关如何按照项目标准和约定开发 WooCommerce 后端 PHP 代码的指导。
何时使用此技能
执行以下操作前,务必调用此技能:
- 编写新的 PHP 单元测试(
*Test.php文件) - 创建新的 PHP 类
- 修改现有后端 PHP 代码
- 添加钩子或筛选器
说明
添加或修改后端 PHP 代码时,请遵循 WooCommerce 项目约定:
- 创建新的代码结构:类的创建和文件组织约定,请参阅 file-entities.md(但创建新的单元测试文件时,请参阅 unit-tests.md)。
- 命名约定:方法、变量和参数的命名,请参阅 code-entities.md
- 编码风格:一般编码标准和最佳实践,请参阅 coding-conventions.md
- 类型注释:了解支持 PHPStan 的 PHPDoc 注释,请参阅 type-annotations.md
- 使用钩子:钩子回调约定和文档,请参阅 hooks.md
- 依赖注入:DI 容器的用法,请参阅 dependency-injection.md
- 数据完整性:执行 CRUD 操作时确保数据完整性,请参阅 data-integrity.md
- 编写测试:单元测试约定,请参阅 unit-tests.md
核心原则
- 始终遵循 WordPress 编码标准
- 使用类方法,而不是独立函数
- 默认将新的内部类放在
src/Internal/中 - 使用
Automattic\WooCommerce命名空间和 PSR-4 自动加载 - 为新功能编写全面的单元测试
- 提交更改前运行代码检查和测试
版本信息
确定 @since 注释所用的下一个 WooCommerce 版本号:
- 读取 trunk 分支中
includes/class-woocommerce.php的$version属性 - 如果存在
-dev后缀,请将其移除 - 示例:如果 trunk 显示
10.4.0-dev,则使用@since 10.4.0 - 注意:相对于已发布版本而言,即使 trunk 中的版本看起来是“未来版本”,审核针对 trunk 的 PR 时仍应使用 trunk 中的版本
评论
支持 Markdown