Merci de vouloir contribuer à Exercism !
Avant de créer une pull request, lis le guide Comment faire une excellente pull request, qui a pour but de t'aider sur l'aspect non technique des pull requests, afin que tu passes un bon moment tout en aidant notre équipe de mainteneurs.
Ce document contient quelques consignes supplémentaires, propres à Exercism, pour différents types de pull requests.
Les pull requests d'exercices
Créer une pull request pour un exercice d'apprentissage ou un exercice d'entraînement peut être intimidant, vu le nombre de règles qui entourent ce type d'exercices.
C'est pourquoi la relecture peut prendre deux à trois heures à un mainteneur et donner lieu à des dizaines de commentaires.
Pour t'aider, un relecteur principal sera désigné pour commenter ta pull request.
Ne te décourage pas devant le nombre de commentaires de relecture : il est parfaitement normal qu'un exercice passe par plusieurs réécritures avant d'arriver à quelque chose qui satisfait à la fois toi et le relecteur principal.
Recommandations
Voici quelques recommandations pour rendre le processus encore plus fluide.
Lis la documentation
Avant de créer une pull request pour un exercice, pense à lire la documentation des exercices d'apprentissage et celle des exercices d'entraînement.
Lire la documentation au préalable aide énormément : la relecture comportera moins de commentaires et ta pull request sera fusionnée bien plus vite.
Examine les exercices existants (s'il y en a)
Si le parcours a déjà des exercices, prends le temps de les étudier un peu pour voir à quoi ils ressemblent et comment ils sont structurés.
Les pull requests d'exercices d'entraînement
Demande-toi si la modification a vraiment sa place dans problems-specifications
Une partie du contenu d'un exercice d'entraînement (comme son introduction) provient de ses métadonnées (partagées), définies dans le dépôt problems-specifications.
Si tu comptes mettre à jour ce genre de contenu, demande-toi si la modification pourrait aussi profiter à d'autres parcours.
Si c'est le cas, ouvre plutôt une pull request sur les métadonnées de l'exercice dans le dépôt problems-specifications.
Recommandations générales
Abstiens-toi de faire des relectures non sollicitées
Toutes les relectures de pull request sont faites par un (ou plusieurs) mainteneurs du parcours, car ce sont eux qui valident toutes les modifications apportées au dépôt.
Que ce soit les mainteneurs qui fassent la relecture permet aussi d'éviter des retours contradictoires pour l'auteur de la pull request.
Tu peux bien sûr laisser un commentaire pour proposer ton aide sur la relecture (surtout pour les grosses pull requests) ou poser des questions si tu remarques quelque chose qui ressemble à une erreur.
