Une pull request (PR) est une fonctionnalité de GitHub qui vous permet de proposer des modifications à un dépôt auquel vous n’avez pas accès en écriture. Les responsables du dépôt peuvent examiner ces modifications et, s’ils le souhaitent, les fusionner dans le dépôt d’origine.
L’ouverture de pull requests sur GitHub est cruciale pour contribuer aux projets open-source et collaborer avec d’autres développeurs. Découvrez comment créer et ouvrir une demande de retrait sur GitHub en quelques étapes simples.
Etape 1 : Forking du référentiel
Forking un dépôt sur la plate-forme GitHub crée une copie – également connu sous le nom de « fork » – de ce dépôt, sous votre compte. Forker un dépôt vous permet d’apporter des modifications au code sans affecter le dépôt original.
Pour forker un dépôt, naviguez vers sa page principale et cliquez sur l’icône fork dans le coin supérieur droit :
Remplissez le nom du dépôt (fork) et une description facultative, puis cliquez sur Créer une fourche:
Vous avez maintenant créé une copie du dépôt d’origine. Ce nouveau dépôt a une connexion avec l’original de sorte que toutes les modifications que vous apportez au code peuvent être facilement comparées et fusionnées.
Étape 2 : Modification du code
Après avoir bifurqué le dépôt, vous devrez peut-être le cloner sur votre machine locale, en fonction de la quantité et de la nature des modifications que vous souhaitez proposer. Si vous effectuez des modifications très simples que vous n’avez pas besoin de tester, vous pouvez le faire en ligne en utilisant l’éditeur web de GitHub.
Pour cloner un dépôt sur votre machine locale à l’aide de Git, exécutez cette commande en terminal :
git clone <REPOSITORY_URL>
Remplacer <REPOSITORY_URL> ; avec l’URL de votre dépôt – vous pouvez la trouver sur GitHub. Cette commande clonera le dépôt sur votre machine locale, où vous pourrez librement expérimenter et apporter des modifications au code.
Vous devez garder vos modifications petites et ciblées, car les demandes de retrait volumineuses peuvent être difficiles à examiner et à fusionner. Essayez de faire en sorte que vos modifications soient spécifiques à un problème ou à une fonctionnalité, afin qu’il soit plus facile pour les mainteneurs de les examiner et de les accepter.
Après avoir effectué les changements souhaités localement, commettez-les et poussez-les vers votre fork GitHub en utilisant Git.
Étape 3 : Ouverture d’une demande de retrait
Après avoir validé vos modifications sur GitHub, vous devriez voir une invite vous avertissant que votre branche a un certain nombre de « commits » d’avance sur le dépôt à partir duquel vous l’avez bifurquée, par exemple :
Cliquez sur le bouton Contribuer dans le menu déroulant. En cliquant sur ce bouton, vous serez invité à ouvrir une demande de retrait. Ensuite, cliquez sur le bouton Ouvrir une demande de retrait bouton :
Certains dépôts ont des directives de contribution spécifiques, que vous pouvez généralement trouver dans un fichier CONTRIBUTING.md, que vous devez suivre. Assurez-vous de lire et de suivre ces directives avant de soumettre une demande de retrait.
Ensuite, remplissez les champs obligatoires et cliquez sur le bouton Créer une demande de retrait bouton :
Votre message de commit doit être clair et concis, décrivant les modifications que vous avez apportées et le raisonnement qui les sous-tend. Cela aidera les responsables à comprendre vos modifications et facilitera la révision du code.
Une fois que vous avez créé votre pull, vous devez attendre que les responsables du projet l’examinent et le fusionnent ou le ferment. Les mainteneurs peuvent avoir des suggestions ou des commentaires sur votre demande de retrait. Soyez ouvert aux changements et prêt à faire des révisions s’ils vous le demandent.
L’importance des Pull Requests
Les demandes de retrait facilitent la collaboration entre les développeurs en leur permettant de proposer des modifications, de fournir des commentaires et de réviser le code. Cela permet d’encourager le sens de la communauté et de la collaboration au sein d’un projet, ce qui conduit à davantage de contributions et à un développement plus rapide.
De plus, les demandes d’extraction organisent l’historique et le versionnage du projet en permettant aux responsables de garder la trace des différentes versions du code et des modifications apportées à chaque version.
