关于 woocommerce-code-review
woocommerce-code-review 是用于审查 WooCommerce 代码变更的技能,依据 WooCommerce 编码规范和约定检查问题。它涵盖 PHP 后端、测试与 UI 文案,并要求给出位置、规范依据和修复建议。
主要功能
- 01检查 PHP 架构与依赖注入
- 02核对命名、条件表达式和文档
- 03检查数据完整性与测试规范
- 04检查 UI 文案句式大小写
- 05按文件位置和标准整理问题
适用场景
- 01审查 WooCommerce PHP 代码变更
- 02检查测试文件和测试方法约定
- 03发现管理界面文案不符合规范的问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ secondsky/ claude-skills --skill woocommerce-code-review安装后在 Claude Code 中输入/woocommerce-code-review确认已加载。
详细介绍
WooCommerce 代码审查
根据 WooCommerce 编码标准和惯例审查代码更改。
需要标记的严重违规
后端 PHP 代码
请参阅 woocommerce-backend-dev 技能,了解详细标准。以这些标准为指导,标记以下违规及类似问题:
架构与结构:
- 独立函数——必须使用类方法(file-entities.md)
- 对由 DI 管理的类使用
new——src/中的类必须使用$container->get()(dependency-injection.md) - 位于
src/Internal/之外的类——除非明确为公共类,否则应使用默认位置(file-entities.md)
命名与惯例:
- camelCase 命名——方法、变量和钩子必须使用 snake_case(code-entities.md)
- Yoda 条件违规——必须遵循 WordPress 编码标准(coding-conventions.md)
文档:
- 缺少
@since注释——公共/受保护方法和钩子必须添加(code-entities.md) - 缺少文档块——所有钩子和方法都必须添加(code-entities.md)
- 文档块冗长——保持简洁,最好写成一行(code-entities.md)
数据完整性:
- 缺少验证——删除或修改前必须验证状态(data-integrity.md)
测试:
- 在测试中使用
$instance——变量名必须使用$sut(unit-tests.md) - 缺少
@testdox——测试方法的文档块中必须包含(unit-tests.md) - 测试文件命名——必须遵循
includes/与src/各自的命名惯例(unit-tests.md)
UI 文案
请参阅 woocommerce-copy-guidelines 技能。标记以下问题:
- UI 中使用标题式大小写——必须使用句子式大小写(sentence-case.md)
- 错误:"Save Changes"、"Order Details"、"Payment Options"
- 正确:"Save changes"、"Order details"、"Payment options"
- 例外:专有名词(WooPayments)、缩写词(API)、品牌名称
审查方法
- 检查上述严重违规
- 标明指出问题时所依据的具体技能文件
- 提供技能文档中的正确示例
- 归类相关问题,让内容更清晰
- 保持建设性——适当说明制定该标准的原因
输出格式
对于发现的每项违规:
[Issue Type]: [Specific problem]
Location: [File path and line number]
Standard: [Link to relevant skill file]
Fix: [Brief explanation or example]
备注
- 所有详细标准均位于
woocommerce-backend-dev、woocommerce-dev-cycle和woocommerce-copy-guidelines技能中 - 请参阅这些技能,了解完整背景和示例
- 如有疑问,请参考上方链接的具体技能文档
评论
支持 Markdown