Vous avez appris à créer une pull request (PR) lorsqu’il existe des indications, soit dans un modèle de PR, soit dans un fichier CONTRIBUTING. Mais que faire si un projet ne fournit pas ces indications ni de documentation sur les conventions à suivre ?

Décrivez vos modifications

Pour rédiger un bon message de commit, et par conséquent une bonne pull request, suivez ces bonnes pratiques :

• La ligne d’objet de votre message de commit Git doit compléter la phrase suivante :
  Si elle est appliquée, cette modification va : <votre ligne d’objet ici>.
• Incluez une description concise du changement en utilisant l’impératif au présent. Par exemple, utilisez ajoute plutôt que ajouté ou ajoute.
• Limitez votre ligne d’objet à 50 caractères.
• Commencez par une majuscule, et ne terminez pas par un point.
• Vous pouvez utiliser des émojis dans votre ligne d’objet et mentionner d’autres utilisateurs GitHub avec @, mais tout le monde n’apprécie pas forcément ce style plus léger.

Pour le corps du message et la description de la pull request, continuez à utiliser le présent. Assurez-vous d’inclure la motivation du changement. Comparez votre modification avec le comportement précédent. Utilisez l’espace disponible pour expliquer le quoi et le pourquoi, plutôt que le comment.

Votre message de commit doit être aussi clair et précis que le contenu que vous soumettez. Soumettez de petits ensembles de modifications isolées. Cette pratique augmente les chances que vos changements soient intégrés au projet.

Ajoutez de la granularité

Avant de soumettre votre pull request, vérifiez la barre latérale pour voir comment la compléter :

• Sélectionnez Reviewers ou Assignees si vous connaissez la structure de l’équipe du projet.
• Ajoutez des étiquettes (labels) s’il y a des indications à ce sujet dans le fichier CONTRIBUTING.md. Les étiquettes servent d’indices visuels sur ce que vous essayez d’accomplir. Un mainteneur peut aussi ajouter une ou plusieurs étiquettes.

Voici quelques étiquettes utilisées dans le dépôt de ce module Learn :

• Bug (rouge) : Quelque chose ne fonctionne pas
• Documentation (bleu) : Améliorations ou ajouts à la documentation
• Duplicate (gris) : Ce ticket ou cette pull request existe déjà
• Enhancement (bleu-vert) : Nouvelle fonctionnalité ou demande

Vous pouvez également lier des tickets dans la barre latérale, afin que la fusion de la pull request ferme automatiquement le ticket correspondant.
Vous pouvez aussi personnaliser votre abonnement aux notifications du fil de discussion. Certaines PR reçoivent de nombreux commentaires, revues et notifications liées à l’intégration continue (CI/CD). Vous pouvez choisir parmi :

• Not subscribed : Vous ne recevez des notifications que si vous avez participé ou été mentionné avec @.
• Subscribed : Vous recevez toutes les notifications de cette pull request.
• Custom : Vous êtes notifié uniquement pour les événements que vous sélectionnez.

Exercice

En utilisant le projet First Contributions, entraînez-vous à forker, cloner et soumettre une pull request.
Le projet First Contributions a pour but de « guider les débutants dans la réalisation de leur première contribution ». Il propose des guides pour l’utilisation de la ligne de commande ainsi que de plusieurs interfaces graphiques (GUI). Le projet prend également en charge plusieurs langues. N’oubliez pas de consulter le dossier Translations.

Avec les leçons des unités précédentes et de celle-ci en tête, retournez à une pull request que vous avez récemment ouverte. Ou bien, allez dans l’onglet Pull requests d’un projet que vous suivez. Observez comment un bon titre peut faire toute la différence. Envisagez de mettre à jour une pull request en conséquence. Consacrez à la rédaction de votre PR autant de soin que vous en avez mis dans la modification du projet. Vos efforts aideront les mainteneurs à catégoriser et prioriser les contributions de la communauté.

---

Bonus

Les utilisateurs interagissent avec les produits via différents moyens : clavier, souris, écran tactile, commande vocale, etc. Il est donc préférable d’utiliser des verbes génériques qui conviennent à tous les types d’interaction. Par exemple, utilisez sélectionner au lieu de cliquer ou glisser.