Une demande d'extraction (PR) est une fonctionnalité GitHub qui vous permet de proposer des modifications à un référentiel auquel vous n'avez pas d'accès en écriture. Les mainteneurs du référentiel peuvent examiner ces modifications et, s'ils le souhaitent, les fusionner dans le référentiel d'origine.
L'ouverture de demandes d'extraction sur GitHub est cruciale pour contribuer à des projets open source et collaborer avec d'autres développeurs. Découvrez comment créer et ouvrir une pull request sur GitHub en quelques étapes simples.
Étape 1: fork le référentiel
Forker un dépôt sur la plateforme GitHub crée une copie, autrement appelée "fork", de ce référentiel, sous votre compte. Forker un référentiel vous permet d'apporter des modifications au code sans affecter le référentiel d'origine.
Pour dupliquer un référentiel, accédez à sa page principale et cliquez sur le fourchette bouton en haut à droite :
Remplissez le nom du référentiel (fork) et une description facultative et cliquez sur Créer une fourchette:
Vous avez maintenant créé une copie du référentiel d'origine. Ce nouveau référentiel a une connexion avec l'original afin que toutes les modifications que vous apportez au code puissent être facilement comparées et fusionnées avec celui-ci.
Étape 2: Apporter des modifications au code
Après avoir forké le référentiel, 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 apportez des modifications très simples que vous n'avez pas besoin de tester, vous pouvez le faire en ligne en utilisant l'éditeur Web GitHub.
Pour cloner un dépôt sur votre ordinateur local à l'aide de Git, exécutez cette commande de terminal :
git cloner
Remplacer avec l'URL de votre référentiel - vous pouvez le trouver sur GitHub. Cette commande clonera le référentiel sur votre ordinateur local, où vous pourrez librement expérimenter et apporter des modifications au code.
Vous devez garder vos modifications petites et ciblées, car les demandes d'extraction volumineuses peuvent être difficiles à examiner et à fusionner. Essayez de garder vos modifications spécifiques à un problème ou à une fonctionnalité, pour faciliter leur révision et leur acceptation par les responsables.
Après avoir apporté les modifications souhaitées localement, validez-les et poussez-les vers votre fork GitHub en utilisant Git.
Étape 3: Ouvrir une demande d'extraction
Une fois que vous avez validé vos modifications sur GitHub, vous devriez voir une invite vous avertissant que votre branche est un certain nombre de "commits" avant le référentiel à partir duquel vous l'avez dérivée, par exemple :
Clique le Contribuer menu déroulant. Cliquer sur ce bouton vous invitera à ouvrir une pull request. Ensuite, cliquez sur le Ouvrir la demande d'extraction bouton:
Certains référentiels 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 d'extraction.
Ensuite, remplissez les champs requis et cliquez sur le Créer une demande d'extraction bouton:
Votre message de validation doit être clair et concis, décrivant les modifications que vous avez apportées et le raisonnement qui les sous-tend. Cela aidera les mainteneurs à comprendre vos modifications et leur facilitera la révision du code.
Une fois que vous avez créé votre pull, vous devrez 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 pull request. Soyez ouvert aux changements et prêt à faire des révisions s'ils vous le demandent.
L'importance des demandes d'extraction
Les demandes d'extraction 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 contribue à favoriser un sentiment de communauté et de collaboration au sein d'un projet, ce qui conduit à davantage de contributions et à un développement plus rapide.
De plus, les pull requests organisent l'historique et la gestion des versions du projet en permettant aux mainteneurs de suivre les différentes versions du code et les modifications apportées à chaque version.