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 從公開儲存庫中收錄這些內容。

檢舉或申請下架