WooCommerce代码审查 woocommerce-code-review

这个技能用于审查WooCommerce项目的代码变更,确保符合编码标准,包括后端PHP代码、UI文本和测试等方面,帮助提高代码质量和维护性。关键词:WooCommerce, 代码审查, 编码标准, PHP, 测试, UI文本。

测试 0 次安装 0 次浏览 更新于 3/7/2026

name: woocommerce-code-review description: 审查WooCommerce代码更改以确保符合编码标准。用于本地审查代码、执行自动化PR审查或检查WooCommerce项目中的代码质量。

WooCommerce 代码审查

根据WooCommerce编码标准和约定审查代码更改。

需要标记的关键违规

后端PHP代码

参考 woocommerce-backend-dev 技能获取详细标准。使用这些标准作为指导,标记以下违规及其他类似问题:

架构与结构:

命名与约定:

文档:

  • 缺少 @since 注释 - 公共或受保护的方法和钩子必须包含 (code-entities.md)
  • 缺少文档块 - 所有钩子和方法必须包含 (code-entities.md)
  • 冗长的文档块 - 保持简洁,理想情况下一行 (code-entities.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)、品牌名

审查方法

  1. 扫描上述关键违规
  2. 标记问题时引用特定技能文件
  3. 从技能文档中提供正确示例
  4. 为清晰起见,分组相关问题
  5. 建设性 - 在相关时解释标准存在的原因

输出格式

对于每个发现的违规:

[问题类型]: [具体问题]
位置: [文件路径和行号]
标准: [相关技能文件链接]
修复: [简要解释或示例]

备注

  • 所有详细标准都在 woocommerce-backend-devwoocommerce-dev-cyclewoocommerce-copy-guidelines 技能中
  • 参考这些技能以获取完整上下文和示例
  • 如有疑问,请参考上述链接的特定技能文档