Woocommerce Code Review

woocommerce/woocommerce/.ai/skills/woocommerce-code-review

作者 woocommerce40608fbc7cca无许可证10K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Review WooCommerce code changes for coding standards compliance. Use when reviewing code locally, performing automated PR reviews, or checking code quality.

AI 生成的概览

依据 WooCommerce 编码标准审查 WooCommerce 代码变更,并报告违规项及修复建议。

功能
该技能指导智能体按照 WooCommerce 编码标准与约定审查 WooCommerce 代码变更。它列出了需要标记的关键违规项,涵盖后端 PHP、前端 JS/TS 以及界面文案,涉及架构、命名、文档、数据完整性和测试。它会为每个违规项生成结构化报告,包含问题类型、位置、标准引用和修复建议。
适用场景
适用于在本地审查 WooCommerce 代码、执行自动化拉取请求审查,或依据 WooCommerce 约定检查代码质量。适合审查 PHP 后端代码、JS/TS 前端代码以及面向用户的文案。
运行要求
不包含脚本,仅为说明性指令。它引用配套技能(woocommerce-backend-dev、woocommerce-dev-cycle、woocommerce-copy-guidelines)及其文档文件以获取详细标准。

WooCommerce Code Review

Review code changes against WooCommerce coding standards and conventions.

Critical Violations to Flag

Backend PHP Code

Consult the woocommerce-backend-dev skill for detailed standards. Using these standards as guidance, flag these violations and other similar ones:

Architecture & Structure:

  • ❌ Standalone functions - Must use class methods (file-entities.md)
  • ❌ Using new for DI-managed classes - Classes in src/ must use $container->get() (dependency-injection.md)
  • ❌ Classes outside src/Internal/ - Default location unless explicitly public (file-entities.md)

Naming & Conventions:

  • ❌ camelCase naming - Must use snake_case for methods/variables/hooks (code-entities.md)
  • ❌ Yoda condition violations - Must follow WordPress Coding Standards (coding-conventions.md)
  • ❌ Magic strings with an existing enum constant - New code comparing or assigning enumerated values (order statuses, product types, ...) must use the Automattic\WooCommerce\Enums constants, not raw literals — except in code that can run during install/upgrade (coding-conventions.md)

Documentation:

  • ❌ Missing @since annotations - Required for public/protected methods and hooks (code-entities.md)
  • ❌ Missing docblocks - Required for all hooks and methods (code-entities.md)
  • ❌ Verbose docblocks - Keep concise, one line is ideal (code-entities.md)

Data Integrity:

  • ❌ Missing validation - Must verify state before deletion/modification (data-integrity.md)

Testing:

  • ❌ Using $instance in tests - Must use $sut variable name (unit-tests.md)
  • ❌ Missing @testdox - Required in test method docblocks (unit-tests.md)
  • ❌ Test file naming - Must follow convention for includes/ vs src/ (unit-tests.md)
  • ❌ Cleanup that duplicates the base lifecycle - Identify the test's base class before requesting post-assertion fixture deletion or state restoration; flag cleanup already covered by its transaction or teardown (unit-tests.md)

Frontend JS/TS Code

Architecture & Structure:

  • ❌ Barrel self-import (circular dependency) — a JS/TS file anywhere in the monorepo importing from its own package barrel (from '../', from '../../', from '../index', from '../../index') when that barrel re-exports it. Relevant to SWC TDZ / esbuild tree-shaking / tsc incremental builds. Fix: use the direct module path instead.

UI Text & Copy

Consult the woocommerce-copy-guidelines skill. Flag:

  • ❌ Title Case in UI - Must use sentence case (sentence-case.md)
    • Wrong: "Save Changes", "Order Details", "Payment Options"
    • Correct: "Save changes", "Order details", "Payment options"
    • Exceptions: Proper nouns (WooPayments), acronyms (API), brand names

Review Approach

  1. Scan for critical violations listed above
  2. Cite specific skill files when flagging issues
  3. Provide correct examples from the skill documentation
  4. Group related issues for clarity
  5. Be constructive - explain why the standard exists when relevant

Output Format

For each violation found:

text
❌ [Issue Type]: [Specific problem]Location: [File path and line number]Standard: [Link to relevant skill file]Fix: [Brief explanation or example]

Notes

  • All detailed standards are in the woocommerce-backend-dev, woocommerce-dev-cycle, and woocommerce-copy-guidelines skills
  • Consult those skills for complete context and examples
  • When in doubt, refer to the specific skill documentation linked above

来源与署名

来源:woocommerce/woocommerce位于.ai/skills/woocommerce-code-review提交40608fb

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架