Pull requests

Comment créer une excellente _pull request_

Les pull requests (PR) sont la façon dont tu proposes des modifications à une partie de la base de code d'Exercism. Si tu lis ceci et que tu prépares une PR, merci ! Ce guide a pour but de t'aider sur l'aspect non technique des PR, pour que tu passes un bon moment tout en aidant notre équipe de mainteneurs.

À quoi t'attendre

Le déroulement d'une PR est le suivant :

  • Tu soumets une PR
  • Un ou plusieurs mainteneurs relisent la PR et laissent des commentaires sous forme de suggestions. Dans certains cas, ils peuvent discuter de la PR dans son ensemble, pour déterminer si c'est la bonne chose à ajouter.
  • Ta PR est fusionnée et tu reçois de la réputation sur le site. Ou ta PR est fermée.

Comment faire pour que ma PR soit fusionnée ?

Certaines choses que tu peux faire en amont augmentent tes chances que ta PR soit fusionnée avec un minimum de modifications.

Le plus important est de t'assurer, avant de soumettre ta PR, que les mainteneurs accueilleront favorablement les changements que tu apportes. Le plus simple pour cela est d'ouvrir d'abord une Issue sur GitHub, en expliquant ce que tu comptes faire et en demandant si les mainteneurs sont ouverts à ces changements.

Note

Si tu trouves une tâche sur le site d'Exercism, il n'est pas nécessaire d'ouvrir une nouvelle Issue. Tu peux commenter l'Issue existante pour dire que tu vas t'en occuper, puis te lancer.

La deuxième chose à faire est de laisser une description claire dans la PR au moment de l'ouvrir. Les PR sans description sont incroyablement frustrantes pour les mainteneurs, car ils n'ont aucun contexte en lisant le code. Dis-nous pourquoi tu as fait ces changements, mets un lien vers l'Issue concernée par la PR, explique les compromis que tu as dû faire, etc.

Enfin, veille à ce que ta PR ne contienne que des changements liés à une seule amélioration. Si tu as plusieurs améliorations, répartis-les sur plusieurs PR. Cela rend la relecture plus facile et plus rapide pour les mainteneurs, et te simplifiera la vie à toi aussi.

Combien de temps faut-il attendre ?

Normalement, les mainteneurs relisent ta PR en quelques jours. Essaie de ne pas relancer la PR avec des commentaires supplémentaires pendant la première semaine : nos mainteneurs sont des bénévoles occupés, qui s'en occuperont dès qu'ils le pourront. Si tu n'as pas eu de réponse au bout de 7 jours, mentionne @exercism/reviewers dans un nouveau commentaire sur la PR, ce qui alertera une équipe plus large.

Merci encore de contribuer à Exercism. Nous espérons que ce sera une expérience amusante et enrichissante !