Skip to content

Commit 264e3de

Browse files
committed
Refondre GitHub Basics autour du parcours GitHub Skills contextuel
1 parent 0e5ca35 commit 264e3de

27 files changed

Lines changed: 627 additions & 655 deletions

‎.github/steps/1-create-a-branch.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## Étape 1 : créer une branche
2+
3+
Bienvenue dans ta première manipulation GitHub.
4+
5+
### Un dépôt et sa branche principale
6+
7+
Le **dépôt** est le projet que tu viens de créer à partir du template. GitHub y stocke les fichiers et leur historique.
8+
9+
Un dépôt peut avoir plusieurs **branches**. Une branche est une version parallèle du projet : elle permet de préparer un changement sans modifier immédiatement la version de référence.
10+
11+
Dans ce dépôt, la branche de référence s'appelle `main`.
12+
13+
### Pourquoi créer une branche ?
14+
15+
Imagine `main` comme la version actuellement validée du projet. Pour essayer une modification, on travaille généralement ailleurs puis on décide plus tard si cette modification doit rejoindre `main`.
16+
17+
Pour cet exercice, tu vas créer :
18+
19+
```text
20+
my-first-branch
21+
```
22+
23+
### Activité : créer `my-first-branch`
24+
25+
1. Ouvre la page principale du dépôt dans un nouvel onglet.
26+
2. Vérifie que tu es dans l'onglet **Code**.
27+
28+
![Onglet Code](../images/code-tab-highlight.png)
29+
30+
3. Ouvre le menu qui affiche actuellement `main`.
31+
32+
<img width="300" alt="Sélecteur de branche GitHub" src="../images/branch-selection-dropdown.png">
33+
34+
4. Dans **Find or create a branch...**, saisis exactement `my-first-branch`.
35+
5. Clique sur **Create branch: my-first-branch from main**.
36+
37+
<img width="300" alt="Création de la branche my-first-branch" src="../images/create-branch-prompt.png">
38+
39+
GitHub bascule automatiquement sur la nouvelle branche.
40+
41+
> [!IMPORTANT]
42+
> Le nom `my-first-branch` est utilisé par l'automatisation du cours. Utilise exactement ce nom.
43+
44+
<details>
45+
<summary>Option terminal, si tu travailles déjà avec une copie locale du dépôt</summary>
46+
47+
```bash
48+
git switch -c my-first-branch
49+
git push -u origin my-first-branch
50+
```
51+
52+
`git switch -c` crée la branche et s'y place. `git push` envoie cette branche vers GitHub.
53+
54+
</details>
55+
56+
Une fois la branche créée sur GitHub, Mona détectera l'action et publiera automatiquement l'étape suivante ici.

‎.github/steps/1-step.md‎

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎.github/steps/2-commit-a-file.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
## Étape 2 : créer un fichier et ton premier commit
2+
3+
Ta branche existe maintenant. Tu peux y modifier le projet sans changer `main`.
4+
5+
### Qu'est-ce qu'un fichier Markdown ?
6+
7+
Tu vas créer `PROFILE.md`. L'extension `.md` indique un fichier **Markdown**, un format texte simple utilisé partout sur GitHub pour écrire des README, de la documentation et des commentaires structurés.
8+
9+
### Qu'est-ce qu'un commit ?
10+
11+
Un **commit** est un point enregistré dans l'historique Git.
12+
13+
Il contient notamment :
14+
15+
- les modifications enregistrées ;
16+
- leur auteur ;
17+
- leur date ;
18+
- un **message de commit** qui résume ce qui a changé.
19+
20+
Un message clair rend l'historique compréhensible pour toi et pour les autres contributeurs.
21+
22+
### Activité : créer `PROFILE.md`
23+
24+
1. Dans l'onglet **Code**, vérifie que la branche affichée est bien `my-first-branch`.
25+
2. Clique sur **Add file**, puis **Create new file**.
26+
27+
<img width="300" alt="Créer un nouveau fichier dans GitHub" src="../images/create-new-file-option.png">
28+
29+
3. Dans **Name your file...**, saisis :
30+
31+
```text
32+
PROFILE.md
33+
```
34+
35+
4. Dans le fichier, écris au minimum :
36+
37+
```markdown
38+
# Mon profil
39+
40+
Hello GitHub !
41+
42+
Je découvre les branches, les commits et la collaboration sur GitHub.
43+
```
44+
45+
![Éditeur GitHub contenant PROFILE.md](../images/add-profile-file.png)
46+
47+
5. Clique sur **Commit changes...**.
48+
6. Dans **Commit message**, écris exactement :
49+
50+
```text
51+
Ajouter PROFILE.md
52+
```
53+
54+
<img width="400" alt="Boîte de dialogue du message de commit" src="../images/commit-message-dialog.png">
55+
56+
7. Confirme avec **Commit changes**.
57+
58+
> [!IMPORTANT]
59+
> Le cours vérifiera trois choses : que `PROFILE.md` existe, qu'il contient le mot `Hello`, et que le message du commit contient `Ajouter PROFILE.md`.
60+
61+
<details>
62+
<summary>Option terminal</summary>
63+
64+
```bash
65+
git switch my-first-branch
66+
printf "# Mon profil\n\nHello GitHub !\n" > PROFILE.md
67+
git add PROFILE.md
68+
git commit -m "Ajouter PROFILE.md"
69+
git push
70+
```
71+
72+
Ici, `git add` prépare le fichier pour le prochain commit, `git commit` crée le commit, puis `git push` envoie ce nouveau commit vers GitHub.
73+
74+
</details>
75+
76+
Dès que GitHub reçoit ce commit sur `my-first-branch`, Mona vérifie ton travail puis affiche l'étape suivante.

‎.github/steps/2-step.md‎

Lines changed: 0 additions & 43 deletions
This file was deleted.
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
## Étape 3 : ouvrir une pull request
2+
3+
Ta branche contient maintenant un changement qui n'existe pas dans `main`.
4+
5+
### Qu'est-ce qu'une pull request ?
6+
7+
Une **pull request**, souvent abrégée **PR**, est une proposition de changement.
8+
9+
Elle compare :
10+
11+
- une branche **base**, ici `main`, qui est la destination ;
12+
- une branche **compare**, ici `my-first-branch`, qui contient ton travail.
13+
14+
Ouvrir une pull request ne modifie pas encore `main`. Tu demandes simplement : « voici mon changement, peut-on l'intégrer ? »
15+
16+
### Activité : créer ta pull request
17+
18+
Après ton commit, GitHub peut afficher **Compare & pull request** :
19+
20+
![Bouton Compare & pull request](../images/compare-pull-request-button.png)
21+
22+
Tu peux cliquer dessus. Sinon, utilise directement :
23+
24+
[**Créer ma pull request →**](../../compare/main...my-first-branch?expand=1)
25+
26+
Si tu passes par l'interface manuelle :
27+
28+
1. ouvre l'onglet **Pull requests** ;
29+
2. clique sur **New pull request** ;
30+
3. choisis :
31+
- **base** : `main`
32+
- **compare** : `my-first-branch`
33+
34+
![Choix des branches d'une pull request](../images/branch-selection-comparison.png)
35+
36+
4. Clique sur **Create pull request**.
37+
38+
### Donner du contexte aux autres
39+
40+
Une PR doit expliquer ce qu'elle propose.
41+
42+
Utilise exactement ce titre :
43+
44+
```text
45+
Ajouter mon profil
46+
```
47+
48+
Puis ajoute une courte description, par exemple :
49+
50+
```markdown
51+
## Description
52+
53+
J'ai ajouté PROFILE.md afin de pratiquer mon premier cycle de contribution sur GitHub.
54+
```
55+
56+
![Formulaire de création d'une pull request](../images/create-pull-request-form.png)
57+
58+
Clique enfin sur **Create pull request**.
59+
60+
> [!IMPORTANT]
61+
> Mona vérifiera le titre et la présence d'une description.
62+
63+
### Ensuite, reste dans la pull request
64+
65+
Une fois la PR créée, **ne reviens pas ici pour chercher la suite**.
66+
67+
Reste dans l'onglet **Conversation** de ta pull request. Le bot GitHub Actions y vérifiera ton travail et y publiera directement l'étape suivante.

‎.github/steps/3-step.md‎

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)