Comment créer facilement un correctif pour un module Drupal
Pour aider les réviseurs à comprendre l'étendue des changements, séparez chaque type de changement dans son propre problème, chacun avec son propre correctif ou sa propre demande de fusion. Par exemple, les corrections de bogues, les améliorations de performances, les corrections de style de code et les corrections d'espacement doivent toutes faire l'objet de problèmes différents. Chaque type de changement distinct doit être associé à un problème différent dans la file d'attente sur Drupal.org.
Depuis de nombreuses années, Drupal.org utilise des correctifs pour gérer les contributions de la communauté. Mais les correctifs sont difficiles à apprendre pour les nouveaux utilisateurs et nécessitent l'utilisation de la ligne de commande. Récemment, le code de Drupal.org a migré vers Gitlab, et nous pouvons maintenant utiliser Gitlab et les problèmes de Drupal.org pour créer des demandes de fusion afin de partager le code et les corrections avec les modules et Drupal Core. Mais, comment utiliser le code sur votre site immédiatement ?
Tout d'abord, assurez-vous que votre problème n'est pas déjà signalé par quelqu'un d'autre dans la file d'attente des problèmes pour le module. Vérifiez également la dernière version du module, le problème est-il résolu ? et suivez les étapes ci-dessous :
- Définissez les conditions préalables : Connexion, Site de développement local (facultatif) et Git à partir de Conditions préalables communes pour les contributeurs.
Trouvez un problème dont le statut est Actif ou Besoin de travail dans le projet de base de Drupal, ou un module, un thème ou un projet de distribution que vous connaissez bien. Si le problème a déjà fait l'objet d'un fork ou d'une demande de fusion, vous devriez faire une demande de fusion plutôt qu'un patch. De même, si le problème est complexe et que vous pensez que de nombreuses personnes pourraient vouloir collaborer à la correction, vous devriez utiliser une demande de fusion. Dans l'un ou l'autre de ces cas, suivez les étapes de la tâche Créer une demande de fusion au lieu de cette rédaction de tâche.
- Lisez la question, en vous assurant que vous comprenez les sections Problème et Résolution proposée du résumé de la question, ou des informations équivalentes. Si le résumé de la question est incomplet ou périmé, consultez la tâche Rédiger un résumé de la question.
- Ajoutez un commentaire au problème en indiquant que vous créez un correctif pour ce problème.
- Utilisez Git pour cloner ou mettre à jour le dépôt du projet, et vérifiez la version pour laquelle vous créez le patch. Créez ensuite une branche locale dans votre dépôt Git pour travailler sur le patch. Consultez la section "Préparer le dépôt local" de la section Créer un patch pour plus de détails.
- Modifiez la base de code avec les changements nécessaires pour résoudre le problème, en suivant l'idée de la section Résolution proposée du résumé. Assurez-vous de respecter les normes de codage, les normes de texte d'interface et les normes de documentation du projet Drupal. Si vous travaillez sur le projet Drupal core, la page Figuring out what Drupal core code to patch peut vous être utile. Si le problème nécessite l'écriture d'un test automatisé, consultez la fiche de tâche sur les tests automatisés.
- Faites un patch qui contient les modifications que vous avez apportées à la base de code.
- Si le problème avait déjà un patch que vous mettez à jour, faites un interdiff entre le patch existant et votre nouveau patch.
- Attacher le patch (et l'interdiff) au problème. Changez le statut du problème en "Needs review". Ajoutez un commentaire expliquant les changements que vous avez effectués et modifiez le résumé du problème si nécessaire. Cliquez sur Enregistrer sur le problème, pour sauvegarder vos fichiers, votre commentaire et les modifications apportées aux champs du problème.