Documentation · Documentation développeur

Configuration du développement local

Cette page décrit la structure publique et sécurisée d'un environnement de développement local pour l'extension. Les constantes exactes, les chemins de fichiers, les scripts d'aide internes et la configuration des services gérés utilisés par la propre configuration de développement d'AD Promotion ne sont pas publiés ici.

Quand utiliser ce document

Utilisez ce document lorsque vous :

  • Contribuez au code, aux modèles ou à la documentation de l'extension à partir d'un fork.
  • Devez reproduire un bug localement avant de le signaler ou de le corriger.
  • Souhaitez évaluer le comportement de l'extension par rapport à une installation WordPress contrôlée.

Les utilisateurs finaux installant l'extension sur un site de production doivent plutôt suivre le guide d'installation du manuel de l'utilisateur.

Configuration requise globale

  • Git pour cloner votre fork du dépôt.
  • PHP à la version minimale déclarée dans l'en-tête de l'extension.
  • Composer pour installer les dépendances de développement (framework de test uniquement ; l'extension n'a pas de dépendances Composer au moment de l'exécution).
  • Une installation WordPress locale à la version minimale de WordPress déclarée dans l'en-tête de l'extension. Tout outil standard de développement local convient (Local, DDEV, Lando, wp-env, Docker, MAMP, LAMP/LEMP natif, etc.).

Flux de travail typique

  1. Clonez votre fork du dépôt.
  2. Placez (ou créez un lien symbolique vers) le dossier de l'extension dans wp-content/plugins/ d'une installation WordPress locale qui correspond aux versions minimales documentées de l'extension.
  3. Activez l'extension depuis wp-admin.
  4. Installez les dépendances de développement avec Composer si vous prévoyez d'exécuter la suite de tests du projet.
  5. Exécutez la suite de tests depuis la racine du projet en suivant le Guide de test.
  6. Apportez vos modifications en respectant les Normes de codage et les Directives de contribution.

Notes d'utilisation

  • Ne commitez jamais de secrets. Configurez tous les identifiants API, jetons d'automatisation ou secrets de webhook via l'interface d'administration de l'extension sur votre site local, et non via des fichiers commités. Ne placez pas d'identifiants dans des extraits wp-config.php suivis par le contrôle de version.
  • Services gérés. Certaines fonctionnalités de l'extension reposent sur des services gérés par AD Promotion qui sont provisionnés pour les sites clients. Pour le développement local de ces fonctionnalités, utilisez vos propres identifiants de test personnels configurés via l'interface d'administration ; la configuration gérée d'AD Promotion n'est pas distribuée.
  • Diagnostics détaillés. Lorsque vous avez besoin de plus de détails de diagnostic localement, activez la journalisation détaillée depuis l'interface d'administration de l'extension plutôt que de dépendre des chemins de journaux internes.

Avis de documentation publique. Cette page fournit uniquement un aperçu de haut niveau de l'intégration. Les détails d'implémentation interne, les API privées, les structures de stockage internes et l'infrastructure de publication sensible à la sécurité sont gérés séparément et ne font pas partie de la documentation publique.