Your first contribution
Closed this issue · 3 comments
Introduction au flux GitHub
Maintenant que vous connaissez les Issues, utilisons ce problème pour suivre votre cheminement vers votre première contribution.
Les gens utilisent différents workflows pour contribuer à des projets logiciels, mais le moyen le plus simple et le plus efficace de contribuer sur GitHub est le workflow GitHub.
📺 Video: Comprendre le flux GitHub
Lisez les étapes suivantes ci-dessous
Étape 4: Création d'une branche
Réalisons la première étape d'une démarche typique sur GitHub : la création d'une branche 📖.
Création d'une branche
Création d'une branche
Vous venez d'apprendre à créer une branche, la première étape du travail sur GitHub.
Les branches sont des éléments importants de la démarche sur GitHub car elles nous permettent d'isoler le travail en cours de la branche principale main
. En d'autres termes, le travail des autres est protégé pendant que vous mettez au point votre contribution.
Conseils pour l'utilisation de branches
Un projet seul peut avoir des centaines de branches, chacune comportant une nouvelle modification de la branche main
.
La meilleure façon de gérer ces branches quand on travaille en équipe est de veiller à les maintenir concises et éphémères. Autrement dit, une branche doit comporter une seule nouvelle fonctionalité ou correction de bug. Les incompréhensions entre contributeurs sont réduites lorsque les branches ne sont actives que quelques jours avant d'être fusionnées 📖 avec la branche main
.
⌨️ Activité : Votre première branche
- Naviguez vers l'onglet Code
- Cliquez Branch: main dans la liste déroulante
- Dans le champs de texte, saisissez un nom de branche, tel que
my-slide
- Cliquez Create branch: ou pressez la touche Enter pour créer votre branche
Je vous répondrai ici lorsque j'aurai détecté qu'une nouvelle branche a été crée dans ce dépôt.
Étape 5: Soumettre un fichier
🎉 Vous avez créé une branche!
Créer une branche vous permet d'apporter des modifications à votre projet sans changer main
, la branche déployée. Maintenant que vous avez une branche, il est temps de créer un fichier et d'effectuer votre première contribution!
Bases de la contribution
Bases de la contribution
Lorsque vous avez fini la création ou l'édition d'un fichier sur GitHub, faites défiler la page jusqu'en bas et répérez la section "Commit new file".
Saisissez un intitulé à la contribution. Ce message doit informer rapidement les contributeurs sur l'objet du changement introduit dans le fichier.
Règles de bienséance pour l'écriture d'un intitulé de contribution:
- Ne pas terminer votre message par un point.
- Restreignez votre message à 50 caractères ou moins. Ajoutez si nécessaire les détails complémentaires dans la fenêtre de description étendue. Elle se situe juste sous la ligne d'intitulé.
- Utilisez la forme active. Par exemple, "Ajout" au lieu de "Ajouté" and "correction" au lieu de "corrigé".
- Considérez votre intitulé de contribution comme l'expression de votre intention lors de l'introduction du changement.
⌨️ Activité: Votre première contribution
Les prochaines étapes vous guideront à travers le processus de soumission d'un changement sur GitHub.
- Sur cette branche, créez un dossier
_posts
et ajoutez y un nouveau fichier nommé0000-01-02-dupontdenis.md
. Vous pouvez le faire en utilisant ce raccourci ou manuellement comme suit:- Retournez à l'onglet "Code"
- Dans la liste déroulante des branches, sélectionnez "denis"
- Cliquez Create new file
- Dans le champ "file name", saisissez
_posts/0000-01-02-dupontdenis.md
. La saisie de/
dans le nom de fichier placera automatiquement votre fichier dans le répertoire_posts
.
- Lorsque vous aurez nommé le fichier, ajoutez-y le contenu suivant:
--- layout: slide title: "Welcome to our second slide!" --- Your text Use the left arrow to go back!
- Après avoir ajouté le texte, vous pouvez soumettre le changement en fournissant un intitulé dans le champ de texte sous la fenêtre d'édition du fichier. Des recommendations relatives aux intitulés de soumission sont disponibles via le lien déroulant Bases de la contribution, juste au-dessus de ces instructions
- Une fois saisis votre intitulé de contribution, cliquez Commit new file
Je vous répondrai lorsque j'aurai détecté une nouvelle contibution sur cette branche.
Étape 6: Ouvrez une Pull Request
Bravo pour cette contribution ✨
Maintenant que vous avez créé une contribution, il est temps de partager la modification que vous proposez via une Pull Request ! Là où les Issues encouragent l'échange avec d'autres contributeurs et collaborateurs sur un projet, les Pull Request vous aident à partager vos modifications, à recevoir des commentaires à leur sujet et à itérer jusqu'à ce qu'elles soient parfaites !
Qu'est-ce qu'une Pull Request ?
Pull requests
Revenons au workflow de GitHub. Vous avez créé une branche, ajouté un fichier et validé le fichier dans votre branche. Il est maintenant temps de collaborer sur votre dossier avec d'autres étudiants qui suivent ce cours. Cette collaboration se produit dans une Pull Request. Visionnez cette vidéo pour en savoir plus :
📺 Video: Introduction aux Pull Requests
Cette Pull Request va conserver les modifications que vous venez de faire sur votre branche tout en proposant de les appliquer également à la branche main
.
⌨️ Activité: Créer une Pull Request
- Ouvrez une Pull Request grâce à ce raccourci ou manuellement comme suit :
- Depuis l'onglet "Pull requests", cliquez New pull request
- Dans le menu déroulant "base:", assurez vous que la branche
main
est sélectionnée - Dans le menu déroulant "compare:", sélectionnez "denis"
- Lorsque vous avez sélectionné votre branche, saisissez un titre pour votre Pull Request. Par exemple
Ajout du fichier de dupontdenis
- Le champ suivant vous aide à fournir une description des modifications que vous avez apportées. N'hésitez pas à ajouter une description de ce que vous avez accompli jusqu'à présent. Pour rappel, vous avez: créé une branche, créé un fichier et effectué une contribution, et ouvert une Pull Request
- Cliquez Create pull request