Les issues sont rédigées en markdown. GitHub à écrit un bon résumer de comment se servir du
markdown ici.
Prérequis
Cette partie est juste là pour vous rappeler les prérequis avant de créer une pull request, vous pouvez la supprimer
avant sa création
Merci pour votre contribution :heart:. Avant de créer la pull request merci d'avoir vérifié que vous remplissez
toutes les conditions de la partie "Liste de vérification". De surcroît, merci de vérifier que vous avez bien
remplis toutes les parties qui suivent et que vous respectez les règles de titre ceci rend le travail des reviewer
plus simples :heart:.
Titre des "pull request" :
Votre titre de pull request doit contenir un libellé ainsi qu'une description brève. Les libellés doivent être
pertinents et minimaliste, voici une liste non exhaustive :
[BOGUE] : Bogue réglé.
[FONCTIONNALITÉ] : Ajout d'une nouvelle fonctionnalité.
[CASSE] : Ajouté ce libellé pour toute PR qui casserai la rétro compatibilité.
[DOCUMENTATION] : mise à jour de la documentation.
Exemple de titre : [BOGUE] Les morceaux d'annanas sur la pizza ont été enlevés
1) Description
Merci d'inclure un résumé des changements et des issue en relation avec la PR. De plus, ajouter la motivation de
cette pull request ainsi que le contexte. N'oubliez pas de lister toutes les dépendances nécessaires pour que ce
changement soit effectif.
2) Choix technique
Pourquoi avez-vous choisi cette méthode d'implémentation ? Pourquoi pas une autre ?
3) Liste de vérification
[ ] Mon code suit les règles de contribution.
[ ] J'ai lu le code de conduite.
[ ] J'ai effectué une relecture de mon code.
[ ] Mes changements n'impliquent pas de nouvelles erreurs ou avertissements.
[ ] Les tests unitaires (nouveaux et anciens) passe localement avec mes nouveaux changements.
Les issues sont rédigées en markdown. GitHub à écrit un bon résumer de comment se servir du markdown ici.
Prérequis
Cette partie est juste là pour vous rappeler les prérequis avant de créer une pull request, vous pouvez la supprimer avant sa création
Merci pour votre contribution :heart:. Avant de créer la pull request merci d'avoir vérifié que vous remplissez toutes les conditions de la partie "Liste de vérification". De surcroît, merci de vérifier que vous avez bien remplis toutes les parties qui suivent et que vous respectez les règles de titre ceci rend le travail des reviewer plus simples :heart:.
Titre des "pull request" :
Votre titre de pull request doit contenir un libellé ainsi qu'une description brève. Les libellés doivent être pertinents et minimaliste, voici une liste non exhaustive :
Exemple de titre :
[BOGUE] Les morceaux d'annanas sur la pizza ont été enlevés1) Description
Merci d'inclure un résumé des changements et des issue en relation avec la PR. De plus, ajouter la motivation de cette pull request ainsi que le contexte. N'oubliez pas de lister toutes les dépendances nécessaires pour que ce changement soit effectif.
2) Choix technique
Pourquoi avez-vous choisi cette méthode d'implémentation ? Pourquoi pas une autre ?
3) Liste de vérification