Travailler avec Git et GitHub

Cette section explique comment la communauté peur contribuer au code de Django au travers de requêtes de contribution (« pull requests »). SI vous vous intéressez à la manière dont les fusionneurs les gèrent, consultez Commit de code.

Nous allons montrer ci-dessous comment créer une requête de contribution GitHub contenant les modifications pour un ticket Trac #xxxxx. En créant une requête de contribution totalement complète, vous faciliterez le travail des relecteurs, ce qui augmentera aussi la probabilité de voir votre code intégré dans Django.

Il est aussi possible de téléverser un correctif traditionnel dans Trac, mais c’est moins pratique pour la relecture.

Installation de Git

Django utilise Git comme système de gestion de version. Vous pouvez télécharger Git, mais il est souvent plus simple de l’installer avec le gestionnaire de paquets de votre système d’exploitation.

Le dépôt GIt de Django est hébergé sur GitHub, et nous vous recommandons aussi de travailler avec GitHub.

Après l’installation de Git, la première chose à faire est de configurer votre nom et votre courriel :

$ git config --global user.name "Your Real Name"
$ git config --global user.email "[e-mail]"

Notez que user.name devrait être votre nom réel, pas un alias GitHub. GitHub devrait reconnaître le courriel que vous indiquez dans le champ user.email, car il sera utilisé pour associer vos commits avec votre compte GitHub.

Configuration d’un dépôt local

Un fois votre compte GitHub créé, avec le pseudonyme « GitHub_nick », et le dépôt Django cloné, créez une copie locale de votre clone :

git clone https://github.com/GitHub_nick/django.git

Cela va créer un nouveau répertoire django contenant un clone de votre dépôt GitHub. Le reste des commandes git de cette page doivent être lancées depuis l’intérieur du dépôt cloné, il faut donc s’y trouver dès maintenant :

cd django

Votre dépôt GitHub sera appelé « origin » dans Git.

Vous devriez aussi configurer django/django` comme cible distante « upstream » (c’est-à-dire indiquer à git que le dépôt Django de référence est la source de votre fourche) :

git remote add upstream https://github.com/django/django.git
git fetch upstream

D’autres cibles distantes peuvent être ajoutées de la même manière, par exemple :

git remote add akaariai https://github.com/akaariai/django.git

Travail sur un ticket

Lorsque vous travaillez sur un ticket, créez une nouvelle branche dédiée à ce travail en la basant sur upstream/main:

git checkout -b ticket_xxxxx upstream/main

L’option -b crée une branche locale. N’hésitez pas à créer de nouvelles branches même pour les plus petites choses, elles sont prévues pour ça.

Si par contre vous travailliez sur une correction dans la branche 1.4, vous auriez écrit :

git checkout -b ticket_xxxxx_1_4 upstream/stable/1.4.x

On part du principe que le travail se fait sur la branche ticket_xxxxx. Faites des modifications et validez-les par commit :

git commit

Lors de l’écriture du message de commit, suivez les lignes directrices des messages de commit pour faciliter le travail avec le fusionneur. Si vous n’êtes pas à l’aise en anglais, essayez au moins de décrire précisément ce que le commit fait.

Si vous devez continuer de travailler sur votre branche, commitez aussi souvent que nécessaire :

git commit -m 'Added two more tests for edge cases'

Publication de votre travail

Vous pouvez publier votre travail sur GitHub en exécutant :

git push origin ticket_xxxxx

Lorsque vous allez sur votre page GitHub, vous pouvez constater qu’une nouvelle branche a été créée.

Si vous travaillez à partir d’un ticket Trac, vous devriez mentionner dans le ticket que votre travail est disponible dans la branche ticket_xxxxx de votre dépôt GiHub. Incluez un lien vers votre branche.

Notez que la branche ci-dessus est appelée une branche thématique (« topic branch ») dans le jargon Git. Vous êtes libre de réécrire l’historique de cette branche, par exemple avec git rebase. D’autres personnes ne devraient pas baser leur travail sur une telle branche, car leur clone serait corrompu dès le moment où vous modifiez des commits.

Il existe aussi des branches publiques. Ce sont des branches que d’autres personnes sont susceptibles de fourcher, ce qui implique que leur historique ne devrait jamais être altéré. De bons exemples de branches publiques sont les branches main et stable/A.B.x dans le dépôt django/django.

Lorsque vous pensez que votre travail est prêt à être intégré dans Django, c’est le moment de créer une requête de contribution (pull request) dans GitHub. Une bonne requête de contribution signifie :

• des commits avec chacun son changement logique, respectant le style de code ;
• des messages correctement formés pour chaque commit : une ligne de résumé puis des paragraphes de lignes à 72 caractères - consultez les lignes directrices pour les commits pour plus de détails ;
• de la documentation et des tests, si nécessaire – en réalité, des tests sont toujours nécessaires à l’exception des modifications de documentation.

La suite de tests doit passer et la documentation doit pouvoir être construite sans avertissement.

Après avoir créà la requête de contribution, vous devriez ajouter un commentaire dans le ticket Trac correspondant en expliquant ce que vous avez fait. En particulier, vous devriez signaler l’environnement dans lequel vous avez lancé les tests, par exemple : « tous les tests passent avec SQLite et MySQL ».

Les requêtes de contribution de GitHub ont seulement deux états : ouvert et fermé. Le fusionneur qui s’occupera de cette requête n’a que deux options, la fusionner ou la fermer. C’est pour cela qu’il n’est pas utile de créer une requête de contribution avant que le code soit prêt à être fusionné, ou suffisamment proche de l’être pour qu’un fusionneur puisse la terminer lui-même.

Rebasage des branches

Dans l’exemple ci-dessus, vous avez créé deux commits, le commit « Fixed ticket_xxxxx » et le commit « Added two more tests ».

Il n’est pas souhaitable d’avoir l’historique complet de votre processus d’avancement dans le dépôt de Django. Le commit « Added two more tests » constituerait un bruit inutile. Il serait donc préférable d’avoir un seul commit contenant l’entier du travail.

Pour réarranger l’historique de votre branche, vous pouvez fusionner les commits en un seul en utilisant le rebasage interactif :

git rebase -i HEAD~2

La syntaxe HEAD~2 ci-dessus est un raccourci indiquant les deux derniers commits. La commande ci-dessus ouvrira un éditeur affichant ces deux commits, préfixés par le mot « pick ».

Modifiez « pick » de la deuxième ligne en « squash ». Cela conservera le premier commit et fusionnera le second commit dans le premier. Enregistrez et quittez l’éditeur. Une seconde fenêtre d’éditeur doit apparaître pour que vous puissiez y reformuler le message de commit pour le nouveau commit qui contient maintenant les changements des deux commits précédents.

Il est aussi possible d’utiliser l’option « edit » dans le rebasage. Cela permet de modifier un seul commit, par exemple pour corriger une faute dans une chaîne de documentation :

git rebase -i HEAD~3
# Choose edit, pick, pick for the commits
# Now you are able to rework the commit (use git add normally to add changes)
# When finished, commit work with "--amend" and continue
git commit --amend
# Reword the commit message if needed
git rebase --continue
# The second and third commits should be applied.

Si votre branche thématique est déjà publiée sur GitHub, par exemple si vous faites des changements mineurs pour prendre en compte une relecture, vous aurez besoin de pousser de force les changements :

git push -f origin ticket_xxxxx

Notez que cela réécrira l’historique de ticket_xxxxx ; si vous comparez les empreintes des commits avant et après l’opération sur GitHub, vous constaterez que les empreintes des commits ont changé. Ceci est acceptable dans la mesure où il s’agit d’une branche thématique et que personne n’est censé baser son travail sur celle-ci.

Après des changements amont

Lorsque des changements surviennent dans le dépôt amont (upstream, django/django), il est nécessaire de rebaser son travail. Pour cela, tapez :

git fetch upstream
git rebase upstream/main

Le travail est automatiquement rebasé en utilisant la branche que vous avez clonée, dans ce cas d’exemple upstream/main.

La commande rebase supprime temporairement tous vos commits locaux, applique les commits amont, puis applique de nouveau vos commits locaux sur la branche.

Si des conflits de fusion sont détectés, il sera nécessaire de les résoudre, puis de continuer avec git rebase --continue. À tout moment, vous pouvez écrire git rebase --abort pour revenir à l’état de départ.

Notez bien que l’intention est de rebaser sur la branche amont, et non pas fusionner (merge) avec la branche amont.

La raison de cette intention est qu’en rebasant, vos commits resteront au-dessus des autres commits amont et ne se mélangeront pas avec eux. De cette façon, votre branche ne contiendra que les commits liés à son objectif, ce qui facilitera une éventuelle fusion de ceux-ci.

Après la relecture

Il est inhabituel de pouvoir pousser une quantité de code non triviale dans le cœur de Django sans procéder à des changements demandés par les relecteurs. Dans ce cas, il est souvent de bon ton d’ajouter les changements sous forme d’un commit suivant vos autres changements. Cela permet au relecteur de visualiser facilement quels sont les changements que vous avez apportés.

Dans ce cas, effectuez les changements demandés par le relecteur. Créez autant de commits que nécessaire. Avant de publier vos changements, rebasez votre travail. Si votre branche a ajouté deux commits, vous exécuteriez :

git rebase -i HEAD~2

Fusionnez le second commit avec le premier. Écrivez un message de commit du genre :

Made changes asked in review by <reviewer>

- Fixed whitespace errors in foobar
- Reworded the docstring of bar()

Pour terminer, poussez à nouveau votre travail dans votre dépôt GitHub. Comme vous n’avez pas touché aux commits publics durant le rebasage, il ne devrait pas être nécessaire pousser de force :

git push origin ticket_xxxxx

Votre requête de contribution devrait maintenant contenir aussi le ou les nouveaux commits.

Notez que le fusionneur va probablement fusionner le commit de relecture dans le commit précédent au moment d’intégrer ce travail dans le code principal de Django.

Travail sur un correctif

L’une des manières de contribuer à Django par les développeurs est de réviser des correctifs. Ces correctifs se trouvent habituellement sous la forme de requêtes de contribution (pull request) dans GitHub et peuvent facilement être intégrés dans un dépôt local :

git checkout -b pull_xxxxx upstream/main
curl -L https://github.com/django/django/pull/xxxxx.patch | git am

Cela va créer une nouvelle branche, puis y appliquer les modifications de la requête de contribution. À ce stade, vous pouvez lancer les tests ou faire tout ce qu’il faut pour examiner la qualité du correctif.

Pour plus de détails sur le travail avec les requêtes de contribution, consultez les lignes directrices pour les fusionneurs.

Sommaire

• Travaillez avec GitHub si vous le pouvez.
• Annoncez votre travail sur le ticket Trac en y ajoutant un lien vers votre branche GitHub.
• Lorsque vous avez du code qui vous semble prêt, créez une requête de contribution (« pull request »).
• Préparez vos requêtes de contribution aussi bien que vous le pouvez.
• Lorsque vous appliquez des corrections à votre travail, utilisez git rebase -i pour fusionner vos commits.
• Lorsque le code principal amont a changé, faites git fetch upstream; git rebase.