home / skills / secondsky / claude-skills / woocommerce-code-review

This skill reviews WooCommerce code changes for coding standards, highlighting architecture, naming, documentation, and data integrity issues to improve

npx playbooks add skill secondsky/claude-skills --skill woocommerce-code-review

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.4 KB
---
name: woocommerce-code-review
description: Review WooCommerce code changes for coding standards compliance. Use when reviewing code locally, performing automated PR reviews, or checking code quality in WooCommerce projects.
---

# 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](../woocommerce-backend-dev/file-entities.md))
- **Using `new` for DI-managed classes** - Classes in `src/` must use `$container->get()` ([dependency-injection.md](../woocommerce-backend-dev/dependency-injection.md))
- **Classes outside `src/Internal/`** - Default location unless explicitly public ([file-entities.md](../woocommerce-backend-dev/file-entities.md))

**Naming & Conventions:**

- **camelCase naming** - Must use snake_case for methods/variables/hooks ([code-entities.md](../woocommerce-backend-dev/code-entities.md))
- **Yoda condition violations** - Must follow WordPress Coding Standards ([coding-conventions.md](../woocommerce-backend-dev/coding-conventions.md))

**Documentation:**

- **Missing `@since` annotations** - Required for public/protected methods and hooks ([code-entities.md](../woocommerce-backend-dev/code-entities.md))
- **Missing docblocks** - Required for all hooks and methods ([code-entities.md](../woocommerce-backend-dev/code-entities.md))
- **Verbose docblocks** - Keep concise, one line is ideal ([code-entities.md](../woocommerce-backend-dev/code-entities.md))

**Data Integrity:**

- **Missing validation** - Must verify state before deletion/modification ([data-integrity.md](../woocommerce-backend-dev/data-integrity.md))

**Testing:**

- **Using `$instance` in tests** - Must use `$sut` variable name ([unit-tests.md](../woocommerce-backend-dev/unit-tests.md))
- **Missing `@testdox`** - Required in test method docblocks ([unit-tests.md](../woocommerce-backend-dev/unit-tests.md))
- **Test file naming** - Must follow convention for `includes/` vs `src/` ([unit-tests.md](../woocommerce-backend-dev/unit-tests.md))

### UI Text & Copy

Consult the `woocommerce-copy-guidelines` skill. Flag:

- **Title Case in UI** - Must use sentence case ([sentence-case.md](../woocommerce-copy-guidelines/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

Overview

This skill reviews WooCommerce code changes for compliance with WooCommerce coding standards and conventions. It focuses on backend PHP patterns, naming conventions, documentation, testing practices, and UI text consistency. Use it to surface critical violations, cite the exact standard, and suggest precise fixes. The feedback is grouped and constructive to speed remediation.

How this skill works

The skill scans diffs or local changes and flags critical violations defined by WooCommerce backend and copy guidelines. For each issue it reports type, file location, the relevant standard, and a concise fix or example. It prioritizes architecture, naming, documentation, data integrity, and test conventions, and it enforces sentence-case UI copy rules.

When to use it

  • Performing automated PR reviews for WooCommerce repositories
  • Reviewing local code changes before committing or opening a PR
  • Auditing code quality across WooCommerce plugins or extensions
  • Enforcing consistent unit test and documentation patterns
  • Checking UI text and copy for sentence-case consistency

Best practices

  • Flag grouped, related issues together to make fixes easier to apply
  • Cite the exact skill file (e.g., woocommerce-backend-dev/code-entities.md) when reporting a violation
  • Provide a minimal code example for the fix rather than a long explanation
  • Prioritize data integrity and testing violations as high severity
  • Keep docblocks concise; prefer one-line summaries with required @since annotations

Example use cases

  • Detecting a standalone function in src/ and recommending conversion to a class method with container retrieval
  • Finding camelCase method names and suggesting snake_case replacements per code-entities rules
  • Identifying missing @since annotations on public methods and adding the required docblock line
  • Reporting tests that use $instance instead of $sut and missing @testdox annotations
  • Flagging UI strings in title case and providing sentence-case replacements

FAQ

What output format does the skill produce?

It emits concise text entries per violation: issue type, file location, standard reference, and a brief fix example.

Which standards does this skill reference?

It references the woocommerce-backend-dev, woocommerce-dev-cycle, and woocommerce-copy-guidelines skills for detailed rules and examples.