Comment contribuer un module Drupal 8 à la communauté?
Avant de décider de contribuer un module à la communauté Drupal, et même avant de créer le module, assurez-vous qu'il n'y a pas déjà un module que quelqu'un d'autre a contribué qui fait la même chose.
Drupal est un outil de création de sites Web. Plus précisément, il s'agit d'un système de gestion de contenu open source (développé par la communauté). Cela signifie qu'il dépend des membres de la communauté (comme vous) pour l'améliorer. Heureusement, contribuer à des modules personnalisés est quelque chose que tout le monde peut faire.
Partie 1 sur 3: préparer le module
- 1Ne réinventez pas la roue (sauf pour vous entraîner). Avant de décider de contribuer un module à la communauté Drupal, et même avant de créer le module, assurez-vous qu'il n'y a pas déjà un module auquel quelqu'un d'autre a contribué et qui fait la même chose. Si c'est le cas, il est probablement préférable de prendre en charge ce module qui crée le vôtre.
- 2Créez le module (si vous ne l'avez pas déjà fait). Si vous n'avez pas encore créé votre module, envisagez d'utiliser Drupal Console (un outil de développement très utile) pour vous aider à le créer pour vous. Une fois qu'il est installé, exécutez simplement la commande
$ drupal generate:moduleet$ drupal module:install {name} - 3Emballez-le pour le donner. Une fois que votre module est prêt à être publié, ajoutez un fichier README.md (markdown) qui explique tout ce qu'une personne utilisant votre module aurait besoin de savoir. Par example:
- Introduction. (ce que ça fait, pour qui c'est)
- Caractéristiques
- Exigences (autres modules, etc.)
- FAQ
- Installation
- Utilisation (comment le développeur / propriétaire du site / visiteur du site l'utilise)
- Dépannage
- Notes techniques (construction, outillage, etc.)
- Mainteneurs (particuliers, entreprises)
- 4Envoyez-le à git. Suivez le processus standard de validation de votre code. Mais avant cela, assurez-vous d'avoir un fichier .gitignore. Utilisez ensuite les commandes
init,add, etcommit.
Si vous n'avez pas encore créé votre module, envisagez d'utiliser Drupal Console (un outil de développement très utile) pour vous aider à le créer pour vous.
Partie 2 sur 3: le livrer à drupal.org
- 1Connectez-vous à drupal.org. Si vous n'avez pas de compte, créez-en un. Connectez-vous ensuite.
- 2Créer un nouveau projet. Allez dans → Votre "Compte"→ Votre page "Projets"→ "Ajouter un nouveau projet"→ "Module Projet".
- 3Remplissez le formulaire de nouveau projet. Il est préférable que vous fournissiez des informations utiles aux personnes qui décident si elles doivent télécharger et utiliser votre module; vous pouvez le prendre dans votre fichier README si vous l'avez créé plus tôt (mais laissez de côté les éléments techniques).
- 4Envoyez-le à drupal.org. Suivez simplement les instructions fournies.
- 5Créer une version. Allez dans "Modifier" → "Versions" → "Ajouter une nouvelle version". Si vous avez correctement poussé le code, vous verrez une option pour créer une nouvelle version.
- 6Remplissez le formulaire de nouvelle version. Voir les conventions de nommage des versions et la création d'une version de projet sur Drupal.org.
- 7Comprendre les versions et la sécurité. Dev → Alpha → Beta → RC → Stable. Pour obtenir une couverture de sécurité (le badge vert) pour votre module, vous devez demander un statut vérifié dans la file d'attente de la couverture des avis de sécurité. Les membres de l'équipe de sécurité ou d'autres bénévoles examineront votre candidature et pourront suggérer des modifications à votre projet. Une fois les commentaires résolus, vous obtiendrez le rôle approuvé et pourrez opter pour ce projet, ainsi que tous les projets futurs que vous créerez, pour recevoir une couverture de conseil de sécurité.
- Seules les versions stables reçoivent une couverture de conseil de sécurité, donc même après avoir activé votre projet, vous ne recevrez pas le bouclier de couverture de conseil, sauf sur les versions stables.
Pour obtenir une couverture de sécurité (le badge vert) pour votre module, vous devez demander un statut vérifié dans la file d'attente de la couverture des avis de sécurité.
Partie 3 sur 3: l'améliorer
- 1Suivez les normes de codage. Drupal a des normes pour la façon dont le code doit être formaté. Par exemple, les tabulations sont préférées aux espaces. Voir les normes de codage sur Drupal.org. Voir également Drupal Markup Style Guide, et même Drupal Security Standards. Pensez à utiliser le module Coder, qui peut vous aider à vous assurer que votre code est correctement formaté.
- 2Écrire des tests. Avoir des tests garantira que votre code fonctionne plus souvent dans plus de cas d'utilisation et entraînera moins de frustration lorsque vous aurez besoin de corriger des bogues. Pensez à utiliser des tests unitaires, des tests fonctionnels, etc. Drupal 8 utilise principalement PHPUnit pour les tests PHP. Envisagez d'utiliser Behat pour les tests fonctionnels.
- 3Rédigez de la documentation (si votre module est complexe). Voir phpDocumentor. En substance, un code intuitif est encore mieux que d'avoir des commentaires, ce qui est certainement mieux que pas de commentaires.
- 4Résoudre les problèmes à l'aide de correctifs. Examinez régulièrement la file d'attente des problèmes de votre module pour les problèmes qui devraient être corrigés. Pour appliquer un correctif, vous pouvez utiliser la commande git ou "patch" (dans la plupart des versions de Linux).
En parallèle
