ドキュメントCommerce実装プレイブック

Adobe Commerceの一般的な開発のベストプラクティス

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 経験者
  • 開発者

ここでは、健全なAdobe Commerce開発プロセスのベースラインについて説明します。 開発者をガイドするための基本的なプロセス、コーディングの原則およびアプリケーション設計の原則について説明します。

NOTE
Adobeテクニカルアーキテクトは、開発を含むエンゲージメントの際の参考としてこれらのベストプラクティスを使用します。

これらのベストプラクティスは、Commerce プロジェクトの開発および提供に関する長年の経験に基づいて開発されています。 Adobeは、技術的な取り組みがこれらのベストプラクティスに従い、既存のプロセスとコードをそれらに合わせて改善することをお勧めします。

テキスト規則

このトピックにおける「必須」、「必須」、「必須」、「必須」、「必須」、「必須」、「必須」、「必須」、「推奨」、「MAY」、「オプション」のキーワードは、RFC 2119 で説明されているように解釈される。

プロセス

  1. プロジェクトアクティビティを開始する前に、定義済みのプロジェクト手法について合意する必要があります。 定義されている限り、スクラム、ウォーターフォール、その他の方法や方法論の組み合わせにすることができます。
  2. 開発チームがバージョン管理システムのブランチ戦略を使用できるようになるまで、開発を開始しないでください。
  3. 技術仕様の承認、ユーザーストーリーとユースケースの承認、テストケースの承認が開発チームに提供されるまで、開発を開始しないでください。
  4. 少なくとも開発環境と QA 環境が使用可能になるまで、開発を開始しないでください。
  5. 開発の開始に必須のプロジェクト固有の要件は、準備完了の定義 に記載されている場合があります。
  6. サインオフは、プロジェクト成果物のサインオフを許可されたクライアント担当者が行う必要があります。
  7. アジャイルプロジェクトの方法論では、承認の後に追加の要件が生じる場合があります。 これらの要件は、新しい要件として扱い、それに応じて取得、構築、計画する必要があります。
  8. すべての開発は、送信前に開発者によって機能的にテストされる必要があります。
  9. すべての開発は、コードレビューのために送信される前に、自動テストに合格する必要があります。 これは、プルリクエスト作成後の自動プロセスとして設定できます。
  10. すべての開発は、品質保証のために送信される前に、テクニカルアーキテクトまたはリード開発者による手動のコードレビューに合格する必要があります。
  11. すべての開発は、クライアントに配信する前に品質保証を渡す必要があります。
  12. 配信に必須のプロジェクト固有の要件は、「完了の定義」に記載されている場合があります。

0.5511122

  1. すべての開発者は同じ IDE を使用する必要があります。 PhpStorm は、Adobe Commerceの開発に推奨される IDE です。
  2. すべての開発者は、（将来の）実稼動サーバーで使用されるのと同じテクノロジースタックを使用して開発およびテストする必要があります。 このテクノロジースタック内のソフトウェアのバージョンは、実稼動サーバーにインストールされているソフトウェアのメジャーバージョンおよびマイナーバージョンと一致する必要があります。 Adobe Commerceの一般的なテクノロジースタックについて詳しくは、 システム要件を参照してください。
  3. システム管理者またはテクニカルアーキテクトは、一元管理されたローカル開発環境をチームに提供して、同じ最新のローカル環境を確保および促進できます。
  4. 開発者と QA エンジニアは、QA 環境のコマンドライン、データベース、ログファイルにアクセスできる必要があります。 VPN 接続が必要になる場合があります。

コーディング標準

  1. すべてのコードは、アーキテクチャ、手法、コーディング標準の規則に従う必要があります。 創造性は形ではなく機能上で望まれています。
  2. すべてのコードは、Adobe Commerce アーキテクチャガイドに従っている必要があります。
  3. すべてのコードは、Adobe Commerceのコーディング標準に準拠する必要があります。
  4. すべてのコードは、Adobe Commerce テクニカルガイドラインに準拠する必要があります。
  5. すべてのコードは、該当する場合、Adobe Commerceのベストプラクティスを実装する必要があります。
  6. すべてのコードは、PHP-Framework Interoperability Group （FIG）標準に準拠する必要があります。
  7. 可能な限り、Adobe Commerce テクニカルビジョンを考慮することをお勧めします。
  8. 外部システムとの統合はすべて、ビジネスプロセスを検証する統合テストが必要です。
  9. すべてのモジュールにテストカバレッジが必要です。 テスト対象は、テクニカルアーキテクトまたはリード開発者と協力して、開発チームが決定する必要があります。 この判断は、定量的な測定ではなく、定性的な測定に基づいて行う必要があります。コードカバレッジの割合が高いことは、成功の指標ではなく、コードの品質が高いことを意味するものでもありません。 むしろ、プログラムの一部におけるリグレッションの確率と重大度を評価して、コードの一部をカバーしないリスクを判断します。

バージョン管理

モジュールバージョンは、Semantic Versioning 2.0.0 標準に準拠する必要があります。
Adobe Commerce コードベースの依存関係は、 モジュールバージョンの依存関係のガイドラインに従う必要があります。

リビジョン管理

コミットには、意味のあるコミットメッセージを付ける必要があります。

セキュリティ

  1. セキュアでない関数を使用しないでください。
  2. XSS 予防戦略を適用すべきである。
  3. コンテンツセキュリティポリシーを適用する必要があります。
  4. 新しいAdobe Commerce インスタンスは、「セキュリティ修正の終了」の日付に達していないバージョンの最新のセキュリティリリースに提供する必要があります。 Adobe Commerce ソフトウェア ライフサイクル ポリシーを参照してください。
recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60