Hello World

Introduction

Ce tutoriel présente les bases essentielles de GitHub, notamment les référentiels, les branches, les commits et les demandes de tirage. Vous allez créer votre propre référentiel de Hello World et apprendre GitHub's pull request workflow, un moyen populaire de créer et de passer en revue du code.

Dans ce guide de démarrage rapide, vous allez :

• Créer et utiliser un référentiel.
• Démarrer et gérer une nouvelle branche.
• Apporter des modifications à un fichier et les transférer sur GitHub sous forme de commits.
• Ouvrir et fusionner une pull request.

Prérequis

• Vous devez avoir un compte GitHub. Pour plus d’informations, consultez Création d’un compte sur GitHub.

• Il n'est pas nécessaire de savoir coder, d'utiliser la ligne de commande ou d'installer Git (le logiciel de contrôle de version sur lequel repose GitHub).

Étape 1 : création d'un référentiel

La première chose que nous allons faire est de créer un référentiel. Vous pouvez imaginer qu’un référentiel est une sorte dossier qui contient des éléments connexes, tels que des fichiers, des images, des vidéos ou même d’autres dossiers. Un référentiel regroupe généralement des éléments qui appartiennent au même « projet » ou à la chose sur laquelle vous travaillez.

Souvent, les dépôts incluent un fichier LISEZ-MOI, à savoir un fichier qui contient des informations sur votre projet. Les fichiers README sont rédigés en Markdown, un langage simple à lire et à écrire destiné à la mise en forme de texte brut. Nous allons en apprendre plus sur Markdown dans le tutoriel suivant, Configuration de votre profil.

GitHub vous permet d'ajouter un fichier README en même temps que vous créez votre nouveau dépôt. GitHub propose également d'autres options courantes telles qu'un fichier de licence, mais vous n'avez pas besoin de les sélectionner pour l'instant.

Votre dépôt hello-world peut constituer un endroit où vous stockez des idées, des ressources, voire même où vous partagez et discutez avec d'autres personnes.

1. Dans le coin supérieur droit de n’importe quelle page, sélectionnez sur , puis cliquez sur Nouveau référentiel.

   

2. Dans la zone « Nom du dépôt », tapez hello-world.

3. Dans la zone « Description », tapez une brève description. Par exemple, tapez « Ce référentiel est destiné à pratiquer le Flow GitHub ».

4. Indiquez si votre dépôt sera public ou privé.

5. Sélectionnez Ajouter un fichier LISEZMOI.

6. Cliquez sur Créer le dépôt.

Étape 2 : Créer une branche

La création de branches vous permet d'avoir différentes versions d'un dépôt en même temps.

Par défaut, votre dépôt a une seule branche nommée main considérée comme la branche définitive. Vous pouvez créer des branches supplémentaires séparées de main dans votre dépôt.

L’utilisation de branche est utile quand vous voulez ajouter de nouvelles fonctionnalités à un projet sans modifier la source principale du code. Le travail effectué sur les différentes branches n'apparaît pas sur la branche principale tant que vous ne l'avez pas fusionné, ce que nous allons aborder plus tard dans ce guide. Vous pouvez utiliser des branches pour expérimenter et apporter des modifications avant de les commiter dans main.

Quand vous créez une branche en dehors de la branche main, vous effectuez une copie, ou un instantané, de cette branche main telle qu'elle est à ce moment-là. Si quelqu'un d'autre a apporté des modifications à la branche main pendant que vous travailliez sur votre branche, vous pouvez intégrer ces mises à jour.

Ce schéma montre :

• La branche main
• Une nouvelle branche appelée feature
• Le parcours que feature suit à travers les étapes « Valider les modification », « Soumettre une demande de tirage » et « Discuter des modifications proposées » avant sa fusion dans main

Création d'une branche

1. Cliquez sur l'onglet Code de votre dépôt hello-world.

2. Au-dessus de la liste des fichiers, cliquez sur le menu déroulant montrant main.

   

3. Tapez un nom de branche, readme-edits, dans la zone de texte.

4. Cliquez sur Créer une branche : readme-edits à partir de main.

   

Maintenant, vous avez deux branches, main et readme-edits. Pour le moment, elles sont strictement identiques. Par la suite, vous allez ajouter des modifications à la nouvelle branche readme-edits.

Étape 3 : Apporter et commiter des modifications

Lorsque vous avez créé une nouvelle branche à l'étape précédente, GitHub vous a amené à la page de code de votre nouvelle readme-editsbranche, qui est une copie de main.

Vous pouvez apporter et enregistrer des modifications dans les fichiers de votre dépôt. Sur GitHub, les modifications enregistrées sont appelées « commits ». Chaque commit est associé à un message de commit qui décrit pourquoi une modification particulière a été apportée. Les messages de commit capturent l'historique de vos modifications afin que d'autres contributeurs puissent comprendre ce que vous avez fait et pourquoi.

1. Sous la branche readme-edits que vous avez créée, cliquez sur le fichier README.md.
2. Pour modifier le fichier, cliquez sur .
3. Dans l'éditeur, présentez-vous en quelques mots.
4. Cliquez sur Commiter les changements.
5. Dans la zone Commiter les modifications, écrivez un message de commit qui décrit vos modifications.
6. Cliquez sur Commiter les changements.

Ces modifications sont uniquement apportées au fichier LISEZ-MOI de votre branche readme-edits. Le contenu de cette branche est donc maintenant différent de celui de main.

Étape 4 : Ouvrir une demande de tirage

Maintenant que vous avez des modifications dans une branche issue de main, vous pouvez ouvrir une pull request.

Les demandes de tirage constituent le cœur de la collaboration sur GitHub. Quand vous ouvrez une demande de tirage (pull request), vous proposez vos modifications et demandez à quelqu’un d’examiner et tirer (pull) votre contribution dans le but de les fusionner dans sa branche. Les demandes de tirage présentent les diffs, ou différences, entre le contenu des deux branches. Les modifications, ajouts et suppressions sont affichés dans des couleurs différentes.

Dès que vous effectuez un commit, vous pouvez ouvrir une pull request et démarrer une discussion, avant même que le code ne soit terminé.

Dans cette étape, vous allez ouvrir une pull request dans votre propre référentiel, puis la fusionner vous-même. C'est un excellent moyen de pratiquer le flux GitHub avant de travailler sur des projets plus importants.

1. Cliquez sur l'onglet Requêtes de tirage de votre dépôt hello-world.

2. Cliquez sur Nouvelle pull request.

3. Dans la zone Exemples de comparaisons, sélectionnez la branche que vous avez créée, readme-edits, pour la comparer à main (l'originale).

4. Examinez vos modifications dans les différences figurant dans la page Comparer pour vérifier qu'elles correspondent bien à ce que vous voulez soumettre.

   

5. Cliquez sur Créer une requête d'extraction.

6. Donnez un titre à votre pull request et décrivez brièvement vos modifications. Vous pouvez inclure des emojis et faire glisser des images et des gifs.

7. Cliquez sur Créer une requête d'extraction.

Examen d'une pull request

Lorsque vous commencez à collaborer avec d’autres personnes, c’est le moment où vous demandez leur révision. Cela permet à vos collaborateurs de commenter ou de proposer des modifications à votre pull request avant la fusion des modifications dans la branche main.

Nous ne couvrirons pas l’examen des demandes de tirage (pull requests) dans ce tutoriel, mais si vous souhaitez en savoir plus, consultez À propos des révisions de demande de tirage. Vous pouvez également essayer le cours GitHub Skills « Examen des pull requests ».

Étape 5 : Fusionnez votre pull request

Dans cette dernière étape, vous allez fusionner votre branche readme-edits dans la branche main. Une fois que vous avez fusionné votre pull request, les modifications apportées à votre branche readme-edits seront incorporées dans main.

Parfois, une pull request peut apporter des modifications au code qui entrent en conflit avec le code existant sur main. S'il y a des conflits, GitHub vous alertera sur le code conflictuel et empêchera la fusion jusqu'à ce que les conflits soient résolus. Vous pouvez effectuer un commit qui résout les conflits ou utiliser des commentaires dans la demande de tirage pour discuter des conflits avec les membres de votre équipe.

Dans cette procédure pas à pas, vous ne devez pas avoir de conflits. Vous êtes donc prêt à fusionner votre branche dans la branche main.

1. En bas de la demande de tirage, cliquez sur Fusionner la demande de tirage pour fusionner les modifications dans main.
2. Cliquez sur Confirmer la fusion. Vous allez recevoir un message indiquant que la demande a été correctement fusionnée et fermée.
3. Cliquez sur Supprimer la branche. Maintenant que votre pull request est fusionnée et que vos modifications sont sur main, vous pouvez supprimer en toute sécurité la branche readme-edits. Si vous voulez apporter d'autres modifications à votre projet, vous pouvez toujours créer une branche et répéter ce processus.
4. Cliquez à nouveau sur l’onglet Code de votre référentiel hello-world pour afficher vos modifications publiées sur main.

Conclusion

En terminant ce tutoriel, vous avez appris à créer un projet et à faire une pull request sur GitHub.

Dans ce cadre, nous avons appris à :

• Créer un référentiel.
• Démarrer et gérer une nouvelle branche.
• Modifier un fichier et livrer ces changements à GitHub.
• Ouvrir et fusionner une pull request.

Étapes suivantes

• Jetez un œil à votre profil GitHub et vous verrez votre travail reflété sur votre graphique de contribution.
• Si vous souhaitez à nouveau vous entraîner sur les compétences que vous avez appris dans ce didacticiel, essayez le cours GitHub Skills « Introduction à GitHub ».
• Dans le prochain tutoriel, Configuration de votre profil , vous apprendrez comment personnaliser votre profil et vous apprendrez également la syntaxe Markdown de base pour écrire sur GitHub.

Pour aller plus loin

• flux de GitHub