blog/content/tutoriel-git-et-github.md

36 KiB
Raw Blame History

+++ title = "[Fr] Tutoriel Git et Github" author = ["Lucien “Phundrak” Cartier-Tilet"] date = 2020-06-05 tags = ["linux", "git", "tutorial", "tutoriel"] categories = ["emacs", "linux", "conlanging", "orgmode"] draft = false [menu.main] weight = 2001 identifier = "fr-tutoriel-git-et-github" +++

Git ? Qu'est-ce donc ?

Git est un logiciel de version de fichiers permettant de garder une trace de toutes les modifications apportées au fichiers suivis dans un répertoire (un dépôt) et ses sous-répertoires sous couvert quils naient pas été ignorés explicitement. Il permet également de conserver plusieurs versions parallèles du projet, comme par exemple une version stable et une version de développement, et permet lajout de modifications dune de ces versions parallèles à une autre via des fusions partielles ou totales de branches, avec une automatisation des fusions de fichiers lorsquil ny a pas de conflit entre ces derniers.

Avant de continuer, sache que je suis bilingue français-sarcasme, si tu es du genre à ténerver pour un rien, cette page est à haut risque pour toi.

Toujours là ? Tu auras été prévenu·e.

Ça a lair cool, comment ça sobtient ?

Et surtout, comment ça sinstalle ?

Très bonne question Kevin. Tout dabord, il faut tassurer que git soit installé sur ton système et utilisable depuis le terminal. Sous GNU/Linux, tu peux linstaller via ton gestionnaire de paquet, ce qui rendra la commande accessible directement depuis le terminal. Tu auras sans doute besoin de préfixer la commande avec sudo. Si tu nas pas les droits pour utiliser sudo, demande à celui qui a les droits (ton administrateur système ou ton papa).

$ apt install git                    # Debian, Ubuntu et les distros basées dessus
$ yum install git                    # CentOS
$ dnf -y install git                 # Fedora
$ pacman -S git                      # ArchLinux et les distros basées dessus
$ emerge --ask --verbose dec-vcs/git # Gentoo

{{< figure src="/ox-hugo/install-gentoo.jpg" caption="Figure 1: >install gentoo" >}}

Si tu nes pas sous GNU/Linux mais que tu as au moins le goût dêtre sous un OS de type Unix, tu peux exécuter la commande correspondante à ton OS suivant :

$ pkg install git                                     # FreeBSD
$ brew install git                                    # macOS avec brew
$ port install git +svn +doc +bash_completion +gitweb # macOS avec MacPorts

Si tu es sous Windows, soit tu utilises le WSL (Windows Subsystem for Linux), soit… bonne chance. Toutes les commandes seront en syntaxe Unix dans ce tutoriel, mais si tu as bien deux neurones, tu devrais pouvoir tout de même suivre le tutoriel.

Ok cest bon, et il y a une configuration à faire ?

Tu peux configurer Git si tu le souhaites, oui. En général, il est recommandé de paramétrer au moins son nom et son e-mail. Tu peux les paramétrer via la ligne de commande :

$ git config --global user.name "Kévin Masturbin"
$ git config --global user.email "kevin.du.neuftrwa@hotmail.com"

Tu peux aussi éditer le fichier ~/.gitconfig comme suit :

[user]
     email = ton@email.truc
     name = Ton nom

Cela permettra dassocier ton nom et ton adresse mail à tes commits. Par défaut, ceux qui sont enregistrés avec ton compte utilisateur de ton PC sont mis par défaut dans ces paramètres, mais on met quasiment tous un nom à la con quand on le créé. Et ça permet davoir les même paramètres si tu es sur un autre ordinateur.

Il y a encore pas mal de paramètres que tu peux gérer avec ce fichier, je reparlerai de certains plus tard, mais pour le reste, la documentation en ligne sur gitconfig ne manque pas.

Ok très bien, comment on lutilise maintenant ?

Du calme Jean-Kevin, ralentis un peu. Comme le dit ce vieux dicton Chinois :

Celui qui marche trop vite…… marche…………… trop… vite…? Cest compliqué les dictons chinois…

De toutes façons, ce dicton est une contrefaçon, donc la qualité de la citation nest pas extraordinaire. Bref.

Je commence comment ?

Si tu souhaites créer un dépôt git, rien de plus simple : créé ton répertoire dans lequel tu travailleras, et déplace-y-toi. Ensuite, tu pourra initialiser ton dépôt via la commande git init.

$ mkdir monsuperprojet
$ cd monsuperprojet
$ git init
Initialized empty Git repository in /tmp/monsuperprojet/.git/

Si tu obtiens à peu près le même message après la dernière commande, félicitations ! Tu viens de créer ton premier dépôt git. En loccurrence, jai créé mon dépôt dans /tmp, mais toi tu peux voir un truc du genre /home/corentin/monsuperprojet à la place. Tu peux vérifier que tout va bien en rentrant la commande git status.

$ git status
On branch master

No commits yet

nothing to commit (create/copy files and use "git add" to track)

Parfait ! Ah, et ne met rien dimportant dans /tmp, ce dossier est réinitialisé à chaque redémarrage de ta machine. Ou alors, met-y uniquement des fichiers que tu ne souhaites avoir que temporairement sur ta machine (comme ce meme que tu télécharges depuis Reddit pour le reposter sur Discord).

Et pour rajouter des fichiers ?

Maintenant tu peux commencer à travailler sur ton projet. Mais tout dabord, on va voir ce quil se passe si jamais on créé un fichier dans le dépôt. Créé un fichier main.c dans lequel tu vas entrer ce code :

#include <stdio.h>

int main(int ac, char* av[]) {
  printf("Hello World!\n");
  return 0;
}

Bref, si tu exécutes à nouveau git status, tu obtients cette sortie :

$ git status
On branch master

No commits yet

Untracked files:
  (use "git add <file>..." to include in what will be committed)

        main.c

nothing added to commit but untracked files present (use "git add" to track)

Tu commences à comprendre un peu le bail ? Git vient de détecter quun nouveau fichier a été créé quil ne connaissait pas avant. Suivons ses bon conseils et ajoutons le fichier au dépôt.

$ git add main.c
$ git status
On branch master

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)

        new file:   main.c

Super, maintenant git va surveiller les changements du fichier, mais attention, il na pas encore enregistré son état. Pour linstant il sait juste que le fichier est là, dans un certain état, mais rien ne garanti encore quon pourra retrouver cet état plus tard. On appelle ça le staging. Pour ce faire, il faut créer ce quon appelle un commit. En gros, il sagit dun enregistrement des modifications apportées à un ou plusieurs fichiers (dans leur globalité ou partiellement, on verra ça plus tard), le tout avec un commentaire.

$ git commit -m "Un petit pas pour moi, un grand pas pour mon projet"
[master (root-commit) 89139ef] Un petit pas pour moi, un grand pas pour mon projet
 1 file changed, 6 insertions(+)
 create mode 100644 main.c

Parfait ! Certains éléments peuvent être un peu différent chez toi, comme par exemple la référence du commit juste avant le message. Ça, cest un truc qui est géré automatiquement par git. Et voilà, on a létat de notre répertoire qui est enregistré et qui sera disponible plus tard. Maintenant, tu sais comment enregistrer des état de ton dépôt via les commits.

Cool, mais jai accidentellement mis un fichier en staging

Si jamais tu as un staging que tu veux annuler, tu peux utiliser la commande git reset HEAD nomdufichier (ou plusieurs noms de fichiers) pour annuler le staging. Une fois le fichier qui nest plus dans ton staging, tu peux même annuler toutes les modifications que tu as apporté au fichier depuis ton dernier commit avec la commande git checkout -- nomdufichier, et tu peux aussi mettre plusieurs noms de fichiers. Par exemple, si jai modifié mon main.c en modifiant ainsi les arguments du main() :

#include <stdio.h>

int main(void) {
  printf("Hello World!\n");
  return 0;
}

Je peux annuler tout ça via ces commandes :

$ git reset HEAD main.c
Unstaged changes after reset:
M       main.c
$ git checkout -- main.c
$ git status
On branch master
nothing to commit, working tree clean

Si je fait un cat main.c, je vois quil est revenu à son état initial.

Et petite remarque concernant les arguments de la fonction main en C : on peut leur donner le nom que lon souhaite (personellement jaime bien parfois metre ac et av au lieu de argc et argv), ça ne changera strictement rien au comportement du code. Et si lon ne souhaite pas utiliser les arguments reçus par le main, on peut simplement déclarer la fonction main comme main(void). Au moins, cest clair pour le compilateur et le lecteur du code : on sen fiche des arguments du main.

Par contre, chose importante : mettre void en arguments du main est du C, et ce nest pas valide en C++. Le C++ nest pas du C avec des fonctionnalités en plus.

En fait, jai juste oublié un truc dans mon commit précédent

Si jamais tu veux à la place ajouter la modification dun fichier au dernier commit (mettons, tu as oublié dajouter également un fichier texte), tu peux utiliser loption --amend lors du commit du fichier oublié.

$ git add main.c # Jai refait les modifications annulées plus tôt
$ git commit -m "second commit"
[master 97f698a] second commit
1 file changed, 1 insertion(+), 1 deletion(-)
$ echo "Cest un super projet !" > projet.txt
$ git add projet.txt
$ git commit --amend -m "second commit + oubli"
[master 9aff4c0] second commit + oubli
Date: Fri Oct 5 11:10:56 2018 +0200
2 files changed, 2 insertions(+), 1 deletion(-)
create mode 100644 projet.txt

En gros, le commit que tu viens de faire a remplacé le précédent en conservant les informations du commit précédent, mis à part son commentaire. Si tu ne met pas loption -m "ton texte" lors de lamendement du commit, ton éditeur texte par défaut va souvrir pour que tu puisses modifier le texte du commit précédent si tu le souhaite. Si jamais vim souvre et que tu nas aucune idée de comment sortir de cet enfant du démon, tu as juste à appuyer sur la touche Échap (au cas où), puis à taper :wq (w pour écrire le fichier, q pour quitter), puis tu appuie sur la touche Entrée. Si tu as Nano qui sest ouvert, alors il faut taper Ctrl-X. Dans tous les cas, tu aurais dû utiliser Emacs.

Euh, jai oublié ce que jai changé lors du dernier commit

Pas de panique ! Tu peux entrer la commande git diff afin de voir ce que tout ce que tu as modifié lors de ton dernier commit. Et si tu ne souhaite voir les modifications que dun certain fichier, tu peux ajouter le nom de ton fichier à la fin de la commande.

$ echo "Cest un super projet !" > projet.txt
$ git diff
diff --git a/projet.txt b/projet.txt
index 03b0f20..b93413f 100644
--- a/projet.txt
+++ b/projet.txt
@@ -1 +1 @@
-projet
+Cest un super projet !

Tu peux également voir les différences de fichiers entre deux commits en entrant leur référence. Pour avoir la référence, tu peux rentrer la commande git log pour avoir un petit historique des commits.

$ git log
commit 4380d8717261644b81a1858920406645cf409028 (HEAD -> master)
Author: Phuntsok Drak-pa <phundrak@phundrak.fr>
Date:   Fri Oct 5 11:59:40 2018 +0200

    new commit

commit 59c21c6aa7e3ec7edd229f81b87becbc7ec13596
Author: Phuntsok Drak-pa <phundrak@phundrak.fr>
Date:   Fri Oct 5 11:10:56 2018 +0200

    nouveau texte

commit 89139ef233d07a64d3025de47f8b6e8ce7470318
Author: Phuntsok Drak-pa <phundrak@phundrak.fr>
Date:   Fri Oct 5 10:56:58 2018 +0200

    Un petit pas pour moi, un grand pas pour mon projet

Bon, cest un peu long et un peu trop dinfos dun coup, généralement je préfère taper git log --oneline --graph --decorate afin davoir un affichage comme suit :

$ git log --oneline --graph --decorate
* 4380d87 (HEAD -> master) new commit
* 59c21c6 nouveau texte
* 89139ef Un petit pas pour moi, un grand pas pour mon projet

Plus propre, non ? Et les références sont plus courtes, ce qui est plus agréable à taper. Allez, comparons les deux derniers commits.

$ git add .
$ git commit -m "new commit"
$ git log --oneline --graph --decorate
* 4380d87 (HEAD -> master) new commit
* 59c21c6 nouveau texte
* 89139ef Un petit pas pour moi, un grand pas pour mon projet
$ git diff 59c21c6 4380d87
diff --git a/projet.txt b/projet.txt
index 03b0f20..b93413f 100644
--- a/projet.txt
+++ b/projet.txt
@@ -1 +1 @@
-projet
+Cest un super projet !

Il y a des fichiers dont je me fiche dans mon dépôt

Dans ce cas, il est grand temps de te présenter le fichier .gitignore. Comme son nom lindique, il permet au dépôt dignorer des fichiers selon ce que tu lui indiqueras. Par exemple, si tu veux ignorer tous les fichiers qui se terminent en .out (ou .exe sous Windows), tu peux éditer (ou créer) ton .gitignore et entrer ces lignes :

*.out
*.exe

Maintenant, si tu créés un fichier en .out ou .exe, il sera complètement ignoré par git et ne sera pas stocké dans lhistorique des versions. Il sagit de ce quon appelle du globbing. En gros, létoile indique que tu ten fiches de ce quil y a devant .out ou .exe dans cet exemple, si quelque chose se termine par ça, cest ignoré. Pour ignorer quelque chose dans un dossier, tu pourrais avoir quelque chose du genre mondossier/* et POUF, tous les fichiers de mondossier/ sont ignorés. En gros, le globbing va fonctionner comme le globbing de ton shell (Bash, Zsh, Fish,…)

Par exemple, voici un dépôt un peu plus complexe que ce quon est en train de faire (figé lors dun commit fixé). Tu peux voir dans mon .gitignore quil y a pas mal dextensions de fichiers qui sont ignorées, mais jai aussi _minted* et auto-generated* qui sont des dossiers ignorés, et pas juste leur contenu qui est ignoré (létoile est là pour ignorer tous les dossiers dont le nom commence par ce qui précède létoile). Jai aussi ignoré le dossier .dart_tool/ qui lui pour le coup na pas de globbing, ainsi que le fichier pubspec.lock, sans globbing non plus.

On est plusieurs dessus en fait…

Pas de panique ! Git a été créé pour ça, et il dispose dune fonctionnalité de branchage permettant davoir plusieurs versions coexistantes dun même fichier. Cela peut être très utile pour avoir soit plusieurs personnes travaillant sur un même projet, soit pour une même personne travaillant sur plusieurs fonctionnalités différentes, soit les deux. Ainsi, on a plusieurs version indépendantes que lon pourra fusionner plus tard.

Par défaut une branche est créée lors de la création dun dépôt qui sappelle master. Pour créer une nouvelle branche, on peut donc utiliser la commande git checkout -b nomdelanouvellebranche.

$ git checkout -b nouvelle-branche
Switched to a new branch 'nouvelle-branche'

À partir dici, toute modification apportée aux fichiers du dépôt naffecteront que la branche courante, nouvelle-branche donc, et les fichiers de la branche master resteront inchangés. Si jamais tu veux retourner pour une quelconque raison sur la branche master, il te suffira dutiliser la commande git checkout master.

Si tu souhaites avoir une liste des branches du dépôt, tu peux taper git branch --list. La branche active sera marquée dune étoile à côté de son nom.

$ git branch --list
  master
* nouvelle-branche

Jai accidentellement modifié des fichiers sur la mauvaise branche, mais je nai pas encore fait de commits.

Tout va bien alors ! Tu vas simplement exécuter cette commande :

$ git stash

Ça va déplacer toutes tes modifications que tu nas pas encore commit dans le stash, qui est une sorte demplacement temporaire, en dehors des branches. Normalement, ça va réinitialiser tes fichiers tels quils étaient lors du dernier commit. Maintenant, change la branche sur laquelle tu travailles, par exemple tu si tu es sur la branche kevin, tu exécutes ceci :

$ git checkout kevin

Tes modifications sont toujours dans ton stack, et pour les restaurer, tu nas plus quà exécuter

$ git stash pop

Et voilà, tu viens de déplacer tes modifications sur la bonne branche. Pour information, si tu as créé un nouveau fichier ou un nouveau dossier avec des fichiers, ils ne seront pas déplacés dans le stash, mais ils ne seront pas supprimés lors de la première commande. Tu auras juste à les commit sur ta nouvelle branche pour quils cessent de se déplacer de branche en branche.

Du coup, Mathilde a bien avancé sur son code, et moi aussi, chacun sur notre branche. On fait comment maintenant ?

Au bout dun moment, tu vas sans doute vouloir fusionner deux branches, par exemple tu as finis de développer une nouvelle fonctionnalité sur la branche nouvelle-branche et tu souhaites lajouter à la version stable de ton code qui se situe sur master. Dans ce cas, ce que tu peux faire, cest retourner sur ta branche master, puis tu vas effectuer ce quon appelle un merge ; en gros, pour faire simple, tu vas appliquer les modifications de la branche que tu souhaites fusionner avec ta branche master sur cette dernière.

$ git checkout master
Switched to branch 'master'
$ git merge nouvelle-branche
Updating 133c5b6..2668937
Fast-forward
 projet.txt | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 projet.txt

Rappelle-toi que la commande merge ramène les commits de la branche spécifiée vers ta branche active, et pas forcément vers le master. Du coup, si tu est sur une branche mathilde et que tu effectues un git merge leon, tu vas ramener tous les commits de leon vers la branche mathilde. Ça peut être intéressant à faire si jamais un bug a été corrigé dans une autre branche ou quune fonctionnalité a été ajoutée et que tu veux en bénéficier dans ta branche active. Noublie juste pas de tout bien commit avant de faire ton merge.

Jai entendu parler de Github…

Tu commences à me plaire Enzo ! Github est un site web sur lequel tu peux héberger des projets libres ou open-source (si tu ne connais pas la différence, voici un article pour taider à comprendre, et un autre pour la route). Cest en particulier orienté pour les projets gérés par git, ce qui tombe bien car cest ce quon utilise. Cela a pour avantage de pouvoir aisément partager ton code et dassurer quil est bien sauvegardé quelque part dautre que ton disque dur (un rm -rf est si vite arrivé). Et surtout, ça peut te permettre de collaborer avec dautres personnes sur le même projet sans te casser la tête.

Git est à Github ce que le porn est à Pornhub.

Jaimerais tout de même te mettre au courant que Github nest largement pas le seul site de ce genre à exister. Le concurrent le plus célèbre de Github est Gitlab, et personnellement jutilise Gitea. Ces deux derniers peuvent même être hébergés en instances personnelles, comme ce que je fais avec Gitea (qui est beaucoup plus léger que Gitlab, mais avec quelques fonctionnalités en moins), et il existe encore plein dautres alternatives, à toi de trouver les autres.

Jai téléchargé un projet en zip

Ou bien, tu peux télécharger le projet directement via git. Eh oui ! git permet de gérer les dépôts dits distants, cest à dire ceux qui sont hébergés sur un serveur en ligne, comme par exemple sur Github. Pour cela, il te faut te munir du lien vers le dépôt git, et le passer en argument de git clone. Par exemple, si tu veux télécharger de dépôt du petit logiciel de chat en réseau que jai codé durant ma L2 dinformatique, tu peux exécuter ceci :

$ git clone https://github.com/noalien/GL4Dummies.git
Cloning into 'GL4Dummies'...
remote: Enumerating objects: 682, done.
remote: Counting objects: 100% (682/682), done.
remote: Compressing objects: 100% (455/455), done.
remote: Total 3516 (delta 354), reused 509 (delta 215), pack-reused 2834
Receiving objects: 100% (3516/3516), 72.95 MiB | 2.13 MiB/s, done.
Resolving deltas: 100% (2019/2019), done.

Et cest bon, tu as accès au répertoire GL4Dummies et au code source du projet. (Courage aux élèves de Paris 8 qui feront de la programmation graphique !)

Et si je veux créer mon propre dépôt sur Github

Dans ce cas là, cest simple Brigitte. Il faut que tu te créés un compte sur Github, puis tu cliques sur le bouton + et New Repository. Tu lui donnes le nom que tu souhaites (en loccurrence je le nomme temporary-repo car je vais le supprimer cinq minutes après lécriture de ces lignes), et tu cliques sur Create Repository. Tu najoutes rien avant, pas de description, pas de .gitignore, RIEN.

Et là, magie ! Github indique comment ajouter le dépôt distant à ton dépôt local.

$ git remote add origin https://github.com/Phundrak/temporary-repo.git

Et voilà, ton dépôt est lié au dépôt distant. Oui, juste comme ça.

Sinon, si tu souhaites dabord créer ton dépôt sur Github puis sur ta machine, tu peux aussi très bien le créer sur Github (logique) puis le cloner sur ta machine comme je te lai montré avant.

Et du coup, comment je met tout ça en ligne ?

Bon ok, ce nest pas aussi simple que ça. Une fois que tu as lié ton dépôt au dépôt distant, il faudra que tu mettes en ligne tes commits quand tu en auras loccasion. Pour ce faire, tu nas quà taper git push ; et la première fois, il faudra que tu indiques à ton dépôt où mettre en ligne précisément dans le dépôt distant, auquel cas tu ajoutes -u origin master pour cette première fois. Git te demandera donc tes identifiants Github pour pouvoir mettre tout ça en ligne.

$ git push -u origin master
Username for 'https://github.com': phundrak
Password for 'https://phundrak@github.com':
Enumerating objects: 10, done.
Counting objects: 100% (10/10), done.
Delta compression using up to 8 threads
Compressing objects: 100% (7/7), done.
Writing objects: 100% (10/10), 940 bytes | 313.00 KiB/s, done.
Total 10 (delta 0), reused 0 (delta 0)
remote:
remote: Create a pull request for 'master' on GitHub by visiting:
remote:      https://github.com/Phundrak/temporary-repo/pull/new/master
remote:
To https://github.com/Phundrak/temporary-repo.git
 * [new branch]      master -> master
Branch 'master' set up to track remote branch 'master' from 'origin'.

Bon, là en nom dutilisateur il y a le mien, faudra remplacer avec le tiens. Et ouais, ma vitesse de mise en ligne nest pas fameuse, je suis sur une connexion 3G+ à lheure où jécris ces lignes, ne me juge pas. Bref, toujours est-il que je viens de mettre en ligne les fichiers du dépôt sur Github. Pas la peine de chercher le mien sur Github par contre, ça fera un bail que je laurai supprimé au moment où tu liras ces lignes.

Pour info, tu peux éviter davoir à taper ton identifiant et ton mot de passe à chaque fois que tu fais un push sur ton dépôt si tu indiques à Github ta clef SSH. Tu auras plus dinformations là (cest à peu près la même merde pour Gitlab, Gitea et Cie).

Quelquun a fait des modifications depuis mon dernier commit, je récupère ça comment?

Pour faire un exemple, je viens de créer un README.md sur Github directement. Ce type de fichiers est assez standard afin de présenter plus ou moins en détails le dépôt et le projet qui y est lié, et son contenu apparaîtra formaté sur la page du dépôt sur Github sil est au format .md (Markdown) ou .org (org-mode, le Markdown dEmacs avec lequel est écrit ce tutoriel, et qui est clairement supérieur à Markdown). Mais il nest pas présent dans mon dépôt local, du coup je vais devoir le récupérer. On va donc entrer git pull.

$ git pull
remote: Enumerating objects: 4, done.
remote: Counting objects: 100% (4/4), done.
remote: Compressing objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
Unpacking objects: 100% (3/3), done.
From https://github.com/Phundrak/temporary-repo
   4380d87..8bd4896  master     -> origin/master
Updating 4380d87..8bd4896
Fast-forward
 README.md | 2 ++
 1 file changed, 2 insertions(+)
 create mode 100644 README.md

Je suis en train de travailler sur le même fichier que Ginette

Là, cest un problème qui aurait pu être évité avec lusage des branches dont je tavais parlé plus haut, mais visiblement, vous êtes sur la même branche. Pas bien. Dans ce cas-là, met-toi daccord avec Ginette pour savoir qui fait ses push en premier. Si le choix tombe sur Ginette, ou si elle a imposé sa vision des choses et a fait son push avant toi, Github va râler car tu nes pas à jour. Dans ce cas ne panique pas, si tu nas pas fait tes commits, lance la commande git stash ; ça va sauvegarder tes modifications dans un coin à part et va annuler tes modifications.

Github ne veut pas de mes pushs sur le dépôt de Gilberte, oskour !

Du calme Jean-Célestin. Cela veut tout simplement dire que tu nas tout simplement pas les droits décriture sur son dépôt. Du coup, soit tu peux lui demander directement à ce quelle te donne les droits décriture si elle a confiance en toi, soit tu peux créer un fork puis une pull-request sur Github depuis ton fork où tu auras fait tes modifications.

Fork ? Pull request ? Que font des fourchettes et des pulls dans ce tuto ?

Ouhlà Billy, il va falloir remettre les choses au clair. Là il sagit de quelque chose de spécifique à Github quà Git (doù le fait quon en discute dans ce chapitre que le précédent).

Sur Github, il est possible de copier vers ton profil le dépôt de quelquun dautre dans létat où il est au moment du fork. Cela inclus les fichiers du master, mais également de toutes les branches du dépôt. Tu peux y penser en terme de super-branche dont tu deviens le propriétaire. Tu peux ainsi travailler comme bon te semble sur le code source sans que son propriétaire ne vienne tengueuler car tu es en train de polluer sa base de code.

Si jamais il y a une modification dont tu es particulièrement fier, tu peux la soumettre au propriétaire du dépôt original (et à ses modérateurs et contributeurs sil y en a) via ce quon appelle une pull-request. Cela signifie donc que tu demandes lautorisation dajouter des commits à la base de code, et ces commits peuvent être lus et commentés par le propriétaire ou les modérateurs. Il peut y avoir une discussion entre toi et les autres personnes qui ont leur mot à dire, le code peut être temporairement refusé, auquel cas tu peux reproposer de nouveau commits sur la même pull-request jusquà ce que ton code soit définitivement accepté ou refusé. Dans tous les cas, cela mènera à la fermeture de ta pull-request, et tu pourras fièrement annoncer que tu as participé à un projet sur Github, ou bien avouer avec toute la honte du monde quil a été refusé.

Jai remarqué un bug ou une erreur, mais je ne peux pas corriger ça moi-même

Eh bien dans ce cas-là, ouvre une issue Bernadette ; issue qui en français veut dire problème. Il sagit dun système de Github te permettant de signaler quelque chose aux propriétaires du dépôt, il peut sagir dun bug, dune demande de fonctionnalité ou de proposition de modification dautres fonctionnalités. Cela peut donner lieu à des discussions menant à la compréhension du bug, ou à une amélioration de ta proposition.

Si tu soumets un bug, avant douvrir une nouvelle issue, assure-toi de bien savoir comment le bug se produit et peut se reproduire. Est-ce que le bug apparaît si tu utilise ou ouvre le logiciel dune autre façon ? Est-ce que le bug apparaît ailleurs ? Est-tu sûr que le bug soit un bug ? Et si tu décides de le partager, assure-toi de partager un maximum dinformation et tout ce que tu sais sur ce bug, en particulier les étapes et conditions pour le reproduire.

Les raccourcis et paramètres de Git

Comme jen avais parlé plus haut, il est possible de configurer git de façon un peu plus poussée que simplement déclarer notre nom et notre adresse e-mail dans notre ~/.gitconfig. Il est par exemple possible de déclarer notre éditeur texte préféré, notre navigateur par défaut ou bien même des raccourcis qui pourront têtre bien utile. Ci dessous je te met une partie de mon fichier de configuration avec quelques-unes de mes préférences et pas mal de mes alias.

[core]
  editor = emacsclient -c
  whitespace = fix,-indent-with-non-tab,trailing-space
[web]
  browser = firefox
[color]
  ui = auto
[alias]
  a = add --all
  c = commit
  cm = commit -m
  cam = commit -am
  co = checkout
  cob = checkout -b
  cl = clone
  l = log --oneline --graph --decorate
  ps = push
  pl = pull
  re = reset
  s = status
  staged = diff --cached
  st = stash
  sc = stash clear
  sp = stash pop
  sw = stash show
a
Permet dajouter dun coup tout nouveau fichier dun dépôt en préparation au commit. On peut faire la même chose avec git add . si on est à la racine du dépôt.
c
Un raccourci pour commit, ça permet déviter quelques frappes de clavier décrire git c plutôt que git commit.
cm
De même pour cm qui évite de devoir écrire commit -m. On na plus quà écrire directement le message de commit après cm.
cam
Non, ce nest pas un plan, cest le même alias que cm mais qui en plus met automatiquement tous les fichiers modifiés ou supprimés, donc sil ny a pas de nouveau fichier à ajouter, même pas besoin de passer par un git a avant le git cam "jaime les pâtes".
co
Pour aller plus vite quand on veut écrire checkout.
cob
Et pour en plus rajouter le flag -b pour la création dune nouvelle branche.
cl
Pour quand tu voudras télécharger ce tutoriel en tapant git cl https://github.com/Phundrak/tutoriel-git.git plutôt que git clone https://github.com/Phundrak/tutoriel-git.git.
l
Te permet davoir le log un peu plus sympa et compact dont javais parlé plus haut.
ps
Pour faire un push plus rapidement.
pl
Et pour télécharger les derniers commits sur le dépôt plus rapidement.
re
Pour réinitialiser plus rapidement.
s
Pour rapidement savoir où tu en es dans ton dépôt, savoir ce qui a été modifié, ajouté, supprimé, déplacé, tout ça…
staged
Eh oui, Git na pas de fonction dédiée pour lister les fichiers en staging, du coup la voilà.
st
Pour sauvegarder tes modifications sur le stash plus rapidement.
sc
Pour supprimer ton stash plus rapidement.
sp
Pour rétablir le stash sur la branche courante plus rapidement.
sw
Pour rapidement savoir ce quil y a sur le stash.

Et cest tout ?

Cest déjà pas mal ! Mais non, ce nest certainement pas tout. Cependant, ce tutoriel na pour but de tapprendre que les bases de Git et de Github, pas de tout tapprendre ! Si tu souhaites aller plus loin, connaître plus de commandes (comme git blame ou git reset), ou bien connaître plus doptions, je ne peux que tinviter à aller te documenter par toi-même sur le site de Git qui se trouve ici, ou bien à consulter des pages de manuel dans ton terminal via man git, man git-apply ou man git-cherry-pick (oui, il faut lier git et le nom de la commande par un tiret dunion).

Si jamais tu as une question, nhésite pas à menvoyer un mail à lucien@phundrak.com. Si jamais tu trouves une erreur dans ce que je viens de dire dans ce tutoriel, ou si tu as une suggestion, cest justement le moment de mettre en pratique ce que tu as lu un peu plus haut et douvrir une issue sur Github sur le dépôt de ce tutoriel.