Faire une demande d’extraction (PR)
Une demande d’extraction, souvent abrégée en PR, est le processus par lequel le code est réintégré au référentiel central. Il fusionne les modifications d’une branche dans une autre. Souvent, les modifications sont fusionnées dans la branche « main » ou « master », mais les PR peuvent être utilisées pour fusionner une branche avec n’importe quelle autre branche, à la fois dans le référentiel central et à partir d’un fork vers le référentiel central.
Ici, vous aurez réalisé un fork du référentiel « deafrica-sandbox-notebooks », donc le PR comprend les étapes suivantes :
Assurez-vous que vos modifications se trouvent sur une branche à jour avec « digitalearthafrica:master »
Ouvrez une PR entre la branche de votre fork et « digitalearthafrica/deafrica-sandbox-notebooks »
Décrivez les changements apportés à votre branche
Soumettre le PR pour examen
Étant donné que nous n’avons apporté aucune contribution substantielle au référentiel dans les exemples de tutoriels précédents, cette PR de démonstration ne sera pas soumise.
Vérifiez que votre succursale distante est à jour
Sur votre fork GitHub du référentiel, utilisez la liste déroulante des branches pour sélectionner la branche contenant les modifications que vous souhaitez proposer. L’en-tête doit indiquer
This branch is XYZ commits ahead of digitalearthafrica:master.
Ces commits sont vos modifications proposées. Si la branche est en retard, effectuez une récupération en amont et fusionnez.
Ouvrir une demande d’extraction
Cliquez sur Contribuer et sélectionnez Ouvrir la demande d’extraction.
Décrivez vos changements
Il s’agit d’une étape importante pour communiquer les raisons pour lesquelles vous souhaitez apporter des modifications au référentiel. Le « deafrica-sandbox-notebooks » a un modèle de PR par défaut : les modifications proposées doivent être résumées et la liste de contrôle de la qualité du code doit être examinée.
Modifiez le titre en quelque chose de plus informatif et complétez la description.
En haut de la page, nous pouvons voir que le PR demandera une fusion du fork de l’utilisateur, d’une branche appelée « git-test », vers la branche du référentiel de base « digitalearthafrica/deafrica-sandbox-notebooks » de « master ».
Une fois la demande de tirage complétée, sélectionnez Créer une demande de tirage.
Que se passe-t-il ensuite ?
La PR devient visible publiquement. Selon les paramètres du référentiel, un ou plusieurs contributeurs devront examiner et approuver la PR avant qu’elle puisse être fusionnée. Cela peut impliquer de modifier vos modifications ou de laisser des commentaires ou des suggestions d’amélioration avant que la fusion puisse avoir lieu.
Quand dois-je faire un PR ?
Les RP doivent effectuer au moins l’une des actions suivantes :
Résoudre un problème ouvert sur le dépôt
Améliorer le code existant en supprimant les fautes de frappe ou en augmentant l’efficacité
Développer le code existant
Il est recommandé de bien connaître le référentiel avant de proposer des modifications importantes. En cas de doute, contactez les propriétaires du référentiel.
Tutoriel wiki GitHub et autres ressources
Une version concise des étapes à suivre pour ouvrir une PR peut être trouvée sur le wiki deafrica-sandbox-notebooks.
De plus, vous pouvez trouver utile ce didacticiel récapitulatif de dataschool.io.
Lisez attentivement les messages d’erreur et utilisez Google (ou votre moteur de recherche préféré) ! Les forums tels que Stackexchange ont les réponses à de nombreux problèmes liés à Git.
Bonus : améliorez ce tutoriel !
Les contributions à ce tutoriel peuvent être faites via une demande d’extraction auprès du référentiel Digital Earth Africa Read the Docs à l’adresse https://github.com/digitalearthafrica/deafrica-docs. Il sera ensuite soumis au processus de révision collaborative décrit ci-dessus.
Le contenu de Digital Earth Africa Read the Docs est principalement écrit en Markdown dans Jupyter Notebooks avec une mise en forme en ReStructuredText (RST).
Conclusion
Merci de nous avoir rejoint dans notre parcours vers la maîtrise de Git. Nous espérons que vous l’avez trouvé utile !