Faire une demande de retrait (PR)

Une demande d’extraction, souvent abrégée en PR, est le processus par lequel du code est reversé dans le dépôt central. Elle fusionne les changements d’une branche vers une autre. Souvent, les changements sont fusionnés dans la branche main ou master, mais les PRs peuvent être utilisées pour fusionner une branche avec n’importe quelle autre branche, à la fois dans le dépôt central et depuis un fork vers le dépôt central.

Ici vous aurez fait un fork du dépôt deafrica-sandbox-notebooks, donc le PR consiste en les étapes suivantes :

1. Assurez-vous que vos changements sont sur une branche qui est à jour avec digitalearthafrica:master.

2. Open a PR between your fork’s branch and digitalearthafrica/deafrica-sandbox-notebooks

3. Décrivez les changements effectués dans votre branche

4. Soumettre le RP pour examen

Comme nous n’avons pas apporté de contribution substantielle au référentiel dans les exemples de tutoriels précédents, ce PR de démonstration ne sera pas soumis.

Vérifiez que votre branche distante est à jour

Sur votre fork GitHub du référentiel, utilisez la liste déroulante des branches pour sélectionner la branche avec les changements que vous voulez proposer. L’en-tête doit indiquer

This branch is XYZ commits ahead of digitalearthafrica:master.

Ces commits sont les changements que vous proposez. Si la branche est en retard, effectuez un fetch en amont et fusionnez.

Ouvrir une demande de modification

Cliquez sur Contribuer et sélectionnez Ouvrir une demande de retrait.

Décrivez vos changements

Il s’agit d’une étape importante pour communiquer les raisons pour lesquelles vous voulez apporter des modifications au référentiel. Le dépôt ``deafrica-sandbox-notebooks`” a un modèle de PR par défaut : les changements proposés doivent être résumés et la liste de contrôle de la qualité du code revue.

Remplacez le titre par quelque chose de plus informatif et complétez la description.

At the top of the page, we can see the PR will request a merge from the user’s fork, from a branch called git-test, to the base repository digitalearthafrica/deafrica-sandbox-notebooks branch of master.

Une fois la soumission PR remplie, sélectionnez Créer une demande de retrait.

Que se passe-t-il ensuite ?

Le PR devient publiquement visible. Selon les paramètres du référentiel, un ou plusieurs contributeurs devront examiner et approuver le PR avant qu’il puisse être fusionné. Cela peut impliquer de modifier vos changements, de laisser des commentaires ou des suggestions d’amélioration avant que la fusion ne puisse avoir lieu.

Quand dois-je faire une RP ?

Les RP doivent faire au moins une des choses suivantes :

• Correction d’un problème ouvert sur le repo

• Améliorer le code existant en supprimant les coquilles ou en augmentant l’efficacité.

• Développer le code existant

Il est bon de se familiariser avec le référentiel avant de proposer des modifications importantes. En cas de doute, prenez contact avec les propriétaires du dépôt.

Tutoriel wiki GitHub et autres ressources

Une version concise des étapes pour ouvrir un PR peut être trouvée sur le wiki deafrica-sandbox-notebooks.

En outre, vous pouvez trouver ce tutoriel sommaire de dataschool.io utile.

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 de Git.

Bonus : améliorez ce tutoriel !

Les contributions à ce tutoriel peuvent être faites par le biais d’une demande de modification du dépôt 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 des carnets de notes Jupyter, avec un peu de formatage en ReStructuredText (RST).

Conclusion

Merci de nous rejoindre sur le chemin de la culture Git. Nous espérons que vous l’avez trouvé utile !