mcpField
W
woocommerce-backend-dev

woocommerce-backend-dev

github.com/woocommerce開発10.6k2.3k 回インストール今日更新
リポジトリ

woocommerce-backend-dev について

WooCommerce のバックエンド PHP を変更する開発者向けのガイドです。コード構成、テスト、フック、依存性注入、データ整合性の規約をまとめています。

主な機能

  1. 01PHP の構成と命名の指針
  2. 02WordPress コーディング規約
  3. 03PHPDoc と型注釈
  4. 04フックと依存性注入
  5. 05CRUD の整合性と単体テスト

活用シーン

  1. 01WooCommerce の PHP クラス追加
  2. 02バックエンドコードやフックの変更
  3. 03PHP 単体テストの作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/woocommerce/woocommerce --skill woocommerce-backend-dev

インストール後、Claude Code で/woocommerce-backend-devを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

code-entities.md
coding-conventions.md
data-integrity.md
dependency-injection.md
file-entities.md
hooks.md
type-annotations.md
unit-tests.md

詳細

WooCommerce バックエンド開発

このスキルでは、プロジェクトの標準と規約に従って WooCommerce のバックエンド PHP コードを開発するためのガイダンスを提供します。

このスキルを使用するタイミング

次の作業を行う前に、必ずこのスキルを実行してください。

  • 新しい PHP 単体テスト(*Test.php ファイル)の作成
  • 新しい PHP クラスの作成
  • 既存のバックエンド PHP コードの変更
  • フックやフィルターの追加

手順

バックエンド PHP コードを追加または変更する際は、WooCommerce プロジェクトの規約に従ってください。

  1. 新しいコード構造の作成:クラスの作成とファイルの整理に関する規約については、file-entities.md を参照してください(ただし、新しい単体テストファイルについては unit-tests.md を参照してください)。
  2. 命名規約:メソッド、変数、パラメーターの命名については、code-entities.md を参照してください。
  3. コーディングスタイル:一般的なコーディング標準とベストプラクティスについては、coding-conventions.md を参照してください。
  4. 型アノテーション:PHPStan 対応の PHPDoc アノテーションについては、type-annotations.md を参照してください。
  5. フックの使用:フックのコールバック規約とドキュメントについては、hooks.md を参照してください。
  6. 依存性注入:DI コンテナーの使用については、dependency-injection.md を参照してください。
  7. データ整合性:CRUD 操作を行う際にデータ整合性を確保する方法については、data-integrity.md を参照してください。
  8. テストの作成:単体テストの規約については、unit-tests.md を参照してください。

主要な原則

  • WordPress コーディング標準に必ず従ってください。
  • 単独の関数ではなく、クラスメソッドを使用してください。
  • 新しい内部クラスは、デフォルトで src/Internal/ に配置してください。
  • Automattic\WooCommerce 名前空間で PSR-4 オートローディングを使用してください。
  • 新しい機能には、包括的な単体テストを作成してください。
  • 変更をコミットする前に、リンティングとテストを実行してください。

バージョン情報

@since アノテーションに使用する次の WooCommerce バージョン番号を確認するには、次の手順に従ってください。

  • trunk ブランチ上の includes/class-woocommerce.php にある $version プロパティを読み取ります。
  • -dev 接尾辞が付いている場合は削除します。
  • 例:trunk に 10.4.0-dev と表示されている場合は、@since 10.4.0 を使用します。
  • 注:trunk に対する PR をレビューする場合、リリース済みのバージョンと比べて「将来」のように見えても、trunk のバージョンが正しいバージョンです。

コメント