Les deux modèles de pull request ont été conçus de manière à fournir une structure claire et cohérente pour les contributeurs lorsqu'ils soumettent leurs pull request. Voici les justifications pour chaque modèle :
Modèle 1 - Pull Request :
Ce modèle met l'accent sur les éléments essentiels à vérifier avant de soumettre une pull request. Voici les justifications pour chaque section :
- "Expliquer le changement apporté" : Cette section permet au contributeur d'expliquer en quelques mots le changement qu'il apporte à travers son pull request.
- "Vérifier que toute la liste a été révisée" : Cette section liste les éléments importants à vérifier avant de soumettre le pull request. Elle s'assure que le contributeur a effectué les vérifications nécessaires pour garantir la qualité du pull request, notamment en ce qui concerne la branche cible, la compilation du code, les tests unitaires et la mise à jour de la documentation. Cela aide à maintenir des normes élevées de qualité du code et de documentation au sein du projet.
Modèle 2 - Pull Request de Remise :
Ce modèle est spécifiquement conçu pour les demandes de tirage lors de la remise d'un laboratoire. Il fournit une structure détaillée pour que les contributeurs puissent présenter leur travail de manière organisée. Voici les justifications pour chaque section :
- "Description" : Cette section permet au contributeur de fournir une description détaillée du travail effectué dans le laboratoire.
- "Liste de vérification" : Cette section énumère les différents éléments que le contributeur doit vérifier pour s'assurer que son code répond aux exigences du laboratoire. Cela comprend des vérifications telles que la compilation sans erreur, le bon fonctionnement du code, le respect des consignes, la clarté du code, les tests unitaires, etc. Cette liste de vérification permet de s'assurer que le contributeur a bien respecté les critères spécifiques du laboratoire.
- "Commentaires additionnels" : Cette section permet au contributeur d'ajouter des commentaires ou des informations supplémentaires qui pourraient être pertinents pour la remise du laboratoire, mais qui ne sont pas couverts par les autres sections.
- "Captures d'écran" : Cette section permet au contributeur d'inclure des captures d'écran ou des fichiers de démonstration pour illustrer visuellement le travail accompli, si nécessaire.
- "Tâches réalisées" : Cette section permet au contributeur de répertorier les différentes tâches effectuées dans le laboratoire, offrant ainsi une vue d'ensemble du travail accompli.
- "Notes de version" : Cette section permet au contributeur de fournir des informations sur les modifications apportées depuis la dernière remise ou la dernière version stable du laboratoire.
- "Problèmes connus" : Cette section permet au contributeur de signaler tout problème ou erreur connus rencontrés lors de la réalisation du laboratoire.
- "Collaborateurs" : Cette section permet d'indiquer la liste des personnes ayant contribué à la remise du laboratoire, favorisant ainsi la transparence et la reconnaissance des contributions individuelles.
En utilisant ces deux modèles de pull request, les contributeurs sont guidés à travers les étapes importantes à suivre avant de soumettre leur travail. Cela permet de garantir la qualité, la clarté et la cohérence des demandes de tirage, facilitant ainsi l'examen et l'intégration des contributions dans le projet.