Documentation · Documentation développeur

Directives de contribution

Cette page explique comment contribuer aux modifications de l'extension à un niveau accessible au public. Les noms de classes internes, les constantes internes et les références à l'infrastructure de publication privée ne sont pas publiés ici.

Quand utiliser ce document

Lisez ce document lorsque vous êtes sur le point de :

  • Ouvrir une pull request qui corrige un bug, ajoute une fonctionnalité ou améliore la documentation.
  • Traduire l'extension dans une nouvelle langue.
  • Soumettre un rapport de sécurité.

Aperçu

Les contributions sont acceptées via des pull requests. Chaque modification doit :

  • Correspondre à la structure et aux conventions existantes (voir Coding Standards).
  • Être couverte par des tests unitaires dans la mesure du possible (voir Testing Guide).
  • Inclure des chaînes traduisibles en utilisant le text domain de l'extension (voir Internationalization For Developers).
  • Appliquer l'assainissement et l'échappement appropriés (voir Sanitization And Escaping) et respecter le modèle de sécurité de haut niveau (voir Security And Capability Checks).
  • Mettre à jour la documentation pertinente sous docs/en/ lorsque le comportement observable publiquement change — et maintenir cette documentation accessible au public.

Exigences ou prérequis

  • Git installé localement et un fork du dépôt.
  • Les versions de PHP et de WordPress déclarées dans l'en-tête de l'extension.
  • Composer installé pour les dépendances de développement (framework de test uniquement).
  • Une installation locale de WordPress fonctionnelle pour valider les modifications qui dépassent la logique testable unitairement (voir Local Development Setup).

Instructions étape par étape

  1. Forkez le dépôt et créez une branche de fonctionnalité (feature branch).
  2. Effectuez votre modification. Suivez les conseils de rédaction sécurisés pour le public pour toute mise à jour de la documentation : n'ajoutez pas de noms de classes internes, de clés d'option, de noms de routes REST/AJAX, de noms de hooks de cron, d'identifiants de capacités/nonces ou de détails sur l'infrastructure de publication dans l'ensemble de documents docs/ publié.
  3. Ajoutez ou mettez à jour des tests unitaires dans la mesure du possible.
  4. Exécutez la suite de tests localement avant d'ouvrir la pull request.
  5. Ouvrez une pull request à partir de votre branche. Décrivez la modification, les tests que vous avez effectués et toutes les mises à jour de la documentation.

Rapports de sécurité

Si vous pensez avoir découvert un problème de sécurité, n'ouvrez pas de ticket public. Contactez AD Promotion en privé afin que le rapport puisse être trié et corrigé avant sa divulgation.

Traductions

Si vous souhaitez contribuer à une traduction, basez votre travail sur le fichier POT du projet sous /languages et soumettez vos fichiers .po / .mo via le processus normal de pull request. Voir Internationalization For Developers.

Avis de documentation publique. Cette page fournit uniquement un aperçu de l'intégration de haut niveau. Les détails d'implémentation interne, les API privées, les composants internes de stockage 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.