Difference between revisions of "Source code management/fr"

From FreeCAD Documentation
Jump to navigation Jump to search
 
(408 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Notre principal outil de gestion de code est [http://en.wikipedia.org/wiki/Git_%28software%29 git]. Cet article explique comment l'utiliser et les règles générales qui s'appliquent dans le cas de FreeCAD. Il est fortement recommandé d'apprendre comment fonctionne git (il existe beaucoup d'informations et de tutoriels à propos de git sur internet) avant de travailler avec le code source de FreeCAD.
+
<languages/>
 +
{{TOCright}}
 +
 
 +
== Introduction ==
 +
 
 +
Le principal outil de gestion de code source du projet FreeCAD est [http://en.wikipedia.org/wiki/Git_%28software%29 Git], qui peut être facilement installé dans la plupart des systèmes d'exploitation à partir d'un gestionnaire de paquets ou directement à partir de [https://git-scm.com/ Git's website]. Nous vous conseillons de vous familiariser avec Git avant de travailler directement avec le code source FreeCAD. Visitez la page [https://git-scm.com/doc Git documentation] pour obtenir le manuel de référence, ainsi que le [https://git-scm.com/book/en/v2 Pro Git book] pour apprendre à utiliser le système de manière générale. Le présent document porte sur l'utilisation de Git pour le développement FreeCAD. La compilation de FreeCAD est décrite dans [[Compiling/fr|Compilation]].
 +
 
 +
Bien que Git soit principalement une application de terminal, il existe de nombreux clients graphiques qui facilitent le travail avec les branches, l’application de correctifs et la soumission de demandes d'extraction à une branche principale. Les exemples incluent [https://git-scm.com/docs/gitk gitk] (la première interface graphique développée), [https://wiki.gnome.org/Apps/Gitg/ gitg] (Gnome), [https://github.com/tibirna/qgit qgit] (Qt), [https://jonas.github.io/tig/ tig] (Ncurses), [http://github.com/git-cola/git-cola git-cola] et [https://www.gitkraken.com/ GitKraken] (propriétaire). Veuillez consulter [[Developing FreeCAD with GitKraken|Developing FreeCAD with GitKraken]] pour une introduction sommaire à cet outil.
 +
 
 +
Remarque: si tout cela commence à vous donner le vertige, il existe une très bonne série non technique sur l'utilisation de git et Github appelée '[https://youtu.be/BCQHnlnPusY Git et Github pour les poètes]'
 +
 
 +
==Accès au code source==
 +
 
 +
Tout le monde peut accéder et obtenir une copie du code source de FreeCAD, mais seuls les gestionnaires de projet(s) peuvent en modifier le contenu. Vous pouvez avoir une copie du code, l'étudier et le modifier comme vous le souhaitez, mais si vous voulez que vos modifications soient prises en compte dans le code source officiel, vous devez effectuer un "pull request" sur le dépôt master. Les gestionnaires pourront alors vérifier vos modifications avant de les valider. Cette façon de développer est connue sous le nom de [https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows flux de travail des dictateurs et des lieutenants] où les développeurs principaux (dictateurs) et développeurs de confiance (lieutenants) filtrent le code soumis par les développeurs et les utilisateurs indépendants.
 +
 
 +
Si votre code source change de manière significative, il vous est conseillé de l'expliquer dans la section [http://forum.freecadweb.org/viewforum.php?f=17 "pull requests"] du forum FreeCAD.
 +
 
 +
[[File:FreeCAD_git_workflow.svg|600px]]
 +
{{Caption|Flux de travail générique pour développer du code pour FreeCAD; Tout le monde peut récupérer le code depuis le dépôt principal, mais les développeurs principaux ont les droits exclusifs pour faire une revue et prendre en compte les changements apportés par les autres développeurs.}}
 +
 
 +
=== Dépôt officiel Github ===
 +
Le code source de FreeCAD est hébergé sur {{URL|https://github.com/FreeCAD/FreeCAD}}
 +
 
 +
Pour pouvoir contribuer et accéder au code source, vous devez avoir un [https://github.com/join compte GitHub].
 +
 
 +
Dans le passé, le code source était hébergé en tant que dépôt SVN, {{URL|https://free-cad.svn.sourceforge.net/svnroot/free-cad}}. Cela a été déplacé vers GitHub le 10 octobre 2011, avec [https://github.com/FreeCAD/FreeCAD/commit/120ca87015 commit 120ca87015].
 +
 
 +
Par conséquent, de nombreuses modifications ont été apportées avant cette date qui ne sont pas enregistrées dans l'historique de validation Git moderne. Pour en savoir plus, consultez la page [[History/fr|Histoire]].
 +
 
 +
=== Configuration de votre nom d'utilisateur Git ===
 +
Les développeurs doivent faire un commit vers leur dépôt de leur code, en utilisant leur nom personnel d'utilisateur GitHub.
 +
Si ce n'est pas déjà fait globalement, vous pouvez le régler au niveau local pour le dépôt Git actuel comme ceci :
 +
 
 +
{{Code|code=
 +
git config user.name "YOUR_NAME"
 +
git config user.email GITHUB_USERNAME@users.noreply.github.com
 +
}}
 +
 
 +
Où {{incode|"YOUR_NAME"}} représente votre nom complet ou votre pseudonyme, utilisé pour identifier l'auteur d'un commit spécifique, et {{incode|GITHUB_USERNAME}} indique le nom de votre compte sur GitHub.
 +
 
 +
=== Note sur les dépôts distants ===
 +
Veuillez lire [https://stackoverflow.com/questions/9257533/ what-is-the-difference-between-origin-and-upstream-on-github#9257901 Quelle est la différence entre l'origine et l'upstream sur GitHub?] (Stackoverflow) pour vous aider à comprendre la différence entre {{incode|origin}} et {{incode|upstream}} dans Git. Cette section explique comment définir les référentiels appropriés pour le développement.
 +
Essentiellement:
 +
* {{incode|origin}} est votre branche personnelle du référentiel officiel de FreeCAD, à savoir, {{URL|https://github.com/GITHUB_USERNAME/FreeCAD}}
 +
* {{incode|upstream}} est le référentiel officiel de FreeCAD, à savoir, {{URL|https://github.com/FreeCAD/FreeCAD}}.
 +
 
 +
La distinction est importante, vous devez d'abord écrire votre code dans votre propre dépôt, avant de "pousser" ces changements sur le dépôt officiel.
 +
 
 +
Sur la base de ce qui précède, il existe deux manières de configurer votre environnement de développement Git:
 +
* 1ère méthode: fork GitHub et clonez votre fork localement
 +
* 2ème méthode: clonez FreeCAD directement sur votre machine locale et ajustez les serveurs distants
 +
 
 +
Nous recommandons la première méthode car c'est la plus rapide.
 +
 
 +
<div class="mw-collapsible mw-collapsed toccolours">
 +
 
 +
==== 1ère méthode: Créez une branche sur GitHub et clonez votre branche localement ====
 +
 
 +
<div class="mw-collapsible-content">
 +
 
 +
Vous allez d'abord créer le référentiel FreeCAD dans GitHub, puis cloner ce fork personnel sur votre ordinateur et enfin définir le référentiel {{incode|upstream}}.
 +
* [https://github.com/join Log in] sur votre compte GitHub.
 +
* Accédez au référentiel officiel FreeCAD: {{URL|https://github.com/FreeCAD/FreeCAD}}
 +
* En haut à droite de la page, appuyez sur le bouton "Fourchette". Cela créera une copie personnelle du référentiel FreeCAD sous votre nom d'utilisateur GitHub: {{URL|https://github.com/GITHUB_USERNAME/FreeCAD}}
 +
* Sur votre machine, clonez votre nouvelle fourche FreeCAD. Il sera créé dans un répertoire {{incode|freecad-source}}.
 +
 
 +
{{Code|code=
 +
git clone https://github.com/GITHUB_USERNAME/FreeCAD.git freecad-source
 +
}}
 +
 
 +
* Une fois le téléchargement terminé, entrez le nouveau répertoire source et définissez le référentiel {{incode|upstream}}.
 +
 
 +
{{Code|code=
 +
cd  freecad-source
 +
git remote add upstream https://github.com/FreeCAD/FreeCAD.git
 +
}}
 +
 
 +
* Confirmez vos référentiels distants avec {{incode|git remote -v}}; la sortie devrait être semblable à celle-ci
 +
 
 +
{{Code|code=
 +
origin https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
 +
origin https://github.com/GITHUB_USERNAME/FreeCAD.git (push)
 +
upstream https://github.com/FreeCAD/FreeCAD.git (fetch)
 +
upstream https://github.com/FreeCAD/FreeCAD.git (push)
 +
}}
 +
 
 +
* Maintenant, le développement peut commencer.
 +
 
 +
</div>
 +
</div>
  
Il existe également de nombreux bons clients graphiques pour git, comme par exemple [http://github.com/git-cola/git-cola git-cola], qui rendent le processus de management des dépôts git plus facile. Il existe également une introduction superficielle au [[Developing FreeCAD with GitKraken]] Développement de FreeCad avec GitKraken 
+
<div class="mw-collapsible mw-collapsed toccolours">
  
== Source Code Access ==
+
==== 2ème méthode: clonez le dépôt officiel FreeCAD git sur votre ordinateur local ====
Everybody can access and get a copy of the FreeCAD source code, but only the FreeCAD project managers have write access to it. You can get a copy of the code, study it and modify it as you wish, but if you make a change that you wish to see included in the official source code, you need to ask for a pull request on the [http://forum.freecadweb.org/viewforum.php?f=17 pull requests] section of the FreeCAD forum.
 
  
{{Note|NOTE|In all examples below, "GITHUB_USERNAME" represents your GitHub user account.}}
+
<div class="mw-collapsible-content">
  
=== Official GitHub Repo ===
+
Vous allez d'abord créer le référentiel FreeCAD dans GitHub, mais vous clonerez le référentiel FreeCAD d'origine sur votre ordinateur local, puis modifierez vos télécommandes via le terminal.
An easy way to start with the FreeCAD source code is using the official FreeCAD repository at
+
* [https://github.com/join Log in] sur votre compte GitHub.
'''https://github.com/FreeCAD/FreeCAD'''
+
* Accédez au référentiel officiel FreeCAD: {{URL|https://github.com/FreeCAD/FreeCAD}}
 +
* En haut à droite de la page, appuyez sur le bouton "Fourchette". Cela créera une copie personnelle du référentiel FreeCAD sous votre nom d'utilisateur GitHub: {{URL|https://github.com/GITHUB_USERNAME/FreeCAD}}
 +
* Clonez le référentiel FreeCAD d'origine. Il sera créé dans un répertoire {{incode|freecad-source}}.
  
=== Setting your git username ===
+
{{Code|code=
Users should commit to their project repository using their GitHub username.
+
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
If that is not already set globally, you can set it locally for the current Git repository like this:
+
}}
git config user.name "YOUR NAME"
 
git config user.email "GITHUB_USERNAME@users.noreply.github.com"
 
Vous pouvez maintenant utiliser une combinaison de commandes "'''git add'''" et "'''git commit'''" pour créer un, ou plusieurs commits dans votre dépôt local.
 
  
==== A note about Remotes ====
+
* Une fois le téléchargement terminé, entrez le nouveau répertoire source et définissez le référentiel {{incode|origin}}.
Please read some [https://stackoverflow.com/questions/9257533/what-is-the-difference-between-origin-and-upstream-on-github#9257901 background] to help you understand better the difference between what '''origin''' and '''upstream''' mean in the context of git. This section explains how to set the correct upstream and origin remote git repos.
 
Essentially:
 
* '''origin''' = Your fork of the FreeCAD git repo AKA https://github.com/GITHUB_USERNAME/FreeCAD.git
 
* '''upstream''' = The official FreeCAD git repo AKA https://github.com/FreeCAD/FreeCAD.git
 
This is important to understand because if you git clone directly from upstream then confusingly, your origin will be listed as https://github.com/FreeCAD/FreeCAD.git
 
So, based on the above, there are 2 main ways to setup your git environment:
 
* [[Source_code_management#Clone_Official_FreeCAD_git_repo_to_your_local_machine|1st Method: Fork on GitHub and clone your fork locally]]
 
* [[Source_code_management#Clone_Official_FreeCAD_git_repo_to_your_local_machine|2nd Method: Clone FreeCAD official directly to your local machine]]
 
We recommend the 1st method for the reason mentioned above.
 
  
==== 1st Method: Fork on GitHub and clone your fork locally ====
+
{{Code|code=
{{Note|Important Note|You will need to re-configure  'remote upstream' as mentioned above in "[[Source_code_management#A_note_about_Remotes|A note about Remotes]]"}}
+
cd freecad-source
This method is the recommended way since it takes less steps. You will essentially fork the FreeCAD repo on your own GitHub account and then clone said GitHub fork locally. Then you will set your '''upstream''' repo in git. The procedure is as follows:
+
git remote add origin https://github.com/GITHUB_USERNAME/FreeCAD.git
<ol>
+
}}
<li>[https://github.com/join Sign up] for a GitHub account if you don't already have one </li>
 
<li>Go to the FreeCAD repo:  https://github.com/FreeCAD/FreeCAD</li>
 
<li>In the top right of the page find and press the "Fork" button (this will essentially git clone the official FreeCAD repo to your personal GitHub repo: https://github.com/GITHUB_USERNAME/FreeCAD.git)  </li>
 
<li>On your machine, clone your newly created FreeCAD fork by opening a terminal and typing:
 
  <pre>git clone https://github.com/GITHUB_USERNAME/FreeCAD.git</pre></li>
 
<li>Once the clone process is complete, now set your '''upstream''' remote repo (see "[[Source_code_management#A_note_about_Remotes|A note about Remotes]]"). Find out what and where your remote git repositories are set to. Type '''git remote -v''' and the output should look similiar to:
 
  <pre> [foo@bar FreeCAD]$ git remote -v
 
    origin https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
 
    origin https://github.com/GITHUB_USERNAME/FreeCAD.git (push)</pre></li>
 
<li>Great. Now set your '''upstream''' repo
 
  <pre>[foo@bar FreeCAD]$ git remote add upstream https://github.com/FreeCAD/FreeCAD.git</pre></li>
 
<li>Check your remotes again, they should look similiar to this:
 
    <pre> [foo@bar FreeCAD]$ git remote -v
 
    origin https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
 
    origin https://github.com/GITHUB_USERNAME/FreeCAD.git (push)
 
    upstream https://github.com/FreeCAD/FreeCAD.git (fetch)
 
    upstream https://github.com/FreeCAD/FreeCAD.git (push)</pre></li>
 
</li>
 
  <li>Now we can start developing. Please refer to "[[Source_code_management#Git_Development_Process|Git Development Process]]"</li>
 
</ol>
 
  
==== 2nd Method: Clone Official FreeCAD git repo to your local machine  ====
+
* Ensuite, configurez le référentiel {{incode|upstream}}.
{{Note|Important Note|You will need to re-configure both 'remote origin' and 'remote upstream' please refer to above "[[Source_code_management#A_note_about_Remotes|A note about Remotes]]"}}
 
This method of setuping your git environment takes a few more steps then the 1st method. You will clone the FC git repo directly to your local machine and then alter your remotes via the terminal. The procedure is as follows:
 
<ol>
 
<li>Clone the FreeCAD code with git:
 
  <pre>git clone https://github.com/FreeCAD/FreeCAD.git</pre></li>
 
<li>Create an account on a public git server (GitHub, GitLab, etc... for our purposes we're assuming it's GitHub)</li>
 
<li>Find out what and where your remote git repositories are set to:
 
    <pre>git remote -v</pre></li>
 
  <li>This will return something that looks like the following:
 
    <pre>[foo@bar FreeCAD]$ git remote -v
 
    origin https://github.com/FreeCAD/FreeCAD.git (fetch)
 
    origin https://github.com/FreeCAD/FreeCAD.git (push)</pre></li>
 
  <li>As was explained above in "[[Source_code_management#A_note_about_Remotes|A note about Remotes]]" you need to modify these remote git repo addresses.<br />
 
So first set up your '''origin''' remote:
 
    <pre>[foo@bar FreeCAD]$ git remote add origin https://github.com/GITHUB_USERNAME/FreeCAD.git</pre></li>
 
  <li>Then we set up our '''upstream''' remote:
 
    <pre>[foo@bar FreeCAD]$ git remote add upstream https://github.com/FreeCAD/FreeCAD.git</pre></li>
 
  <li>Check your remotes again, they should look similiar to this:
 
    <pre> [foo@bar FreeCAD]$ git remote -v
 
    origin https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
 
    origin https://github.com/GITHUB_USERNAME/FreeCAD.git (push)
 
    upstream https://github.com/FreeCAD/FreeCAD.git (fetch)
 
    upstream https://github.com/FreeCAD/FreeCAD.git (push)</pre></li>
 
  <li>Now we can start developing. Please refer to "[[Source_code_management#Git_Development_Process|Git Development Process]]"</li>
 
</ol>
 
  
== Git Development Process ==
+
{{Code|code=
First of all '''NEVER DEVELOP ON THE ''master'' BRANCH!'''
+
git remote add upstream https://github.com/FreeCAD/FreeCAD.git
Instead, create a local branch for development. You can learn in more depth by reading [https://book.git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging Git-Branching-Basic-Branching-and-Merging chapter on git-scm]. Below is a summary:
+
}}
 +
 
 +
* Confirmez vos référentiels distants avec {{incode|git remote -v}}; la sortie devrait être semblable à celle-ci
 +
 
 +
{{Code|code=
 +
origin https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
 +
origin https://github.com/GITHUB_USERNAME/FreeCAD.git (push)
 +
upstream https://github.com/FreeCAD/FreeCAD.git (fetch)
 +
upstream https://github.com/FreeCAD/FreeCAD.git (push)
 +
}}
 +
 
 +
* Maintenant, le développement peut commencer.
 +
 
 +
</div>
 +
</div>
 +
 
 +
Si, pour une raison quelconque, les référentiels distants existent mais indiquent une adresse incorrecte, vous pouvez remédier à la situation en renommant le nom du référentiel distant. Par exemple, {{incode|origin}} doit pointer sur votre branche personnelle; s'il pointe vers le référentiel FreeCAD d'origine, remplacez le nom de cette télécommande par {{incode|upstream}} et ajoutez manuellement le référentiel {{incode|origin}}.
 +
 
 +
{{Code|code=
 +
git remote rename origin upstream
 +
git remote add origin https://github.com/GITHUB_USERNAME/FreeCAD.git
 +
git remote -v
 +
}}
 +
 
 +
Vous pouvez également afficher plus d'informations avec le mot clé {{incode|show}}.
 +
 
 +
{{Code|code=
 +
git remote show origin
 +
git remote show upstream
 +
}}
 +
 
 +
== Processus de développement Git ==  
 +
 
 +
{{VeryImportantMessage|Ne développez jamais sur votre branche '''master''' locale. Au lieu de cela, créez une branche locale pour le développement, puis fusionnez cette branche locale avec la branche principale en amont via une demande d'extraction. Veuillez lire [https://git-scm.com/book/fr/v2/Git-Branching-Branches-in-a-Nutshell Git Branching], [https://book.git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Fusion Fusioning], et [https://git-scm.com/book/fr/v2/GitHub-Contributing-to-a-Project GitHub - Contribuer à un projet] pour en savoir plus}}
 +
 
 +
[[File:FreeCAD_git_branches_workflow.svg|800px]]
 +
{{Caption|Flux de travail générique pour développer du code pour FreeCAD en utilisant {{incode|git}}; Un "fork" du dépôt principal est créé sur le serveur distant et cloné sur un ordinateur local (0); De nouvelles branches (1) sont utilisées pour appliquer des modifications et des ajouts de code localement (2); Les branches sont "rechargées" avec la version de code la plus récente du serveur (3), et elles sont ensuite "poussées" vers le dépôt distant (4); Puis un "Pull Request" est créé afin de pouvoir fusionner le code dans le dépôt principal (5). Le clone du "fork" sur l'ordinateur local est alors mis à jour avec le nouveau code master du serveur (a); ce master mis à jour est également "poussé" vers le dépôt distant (b) afin d'obtenir le même code à la fois sur le serveur distant et l'ordinateur local.}}
  
 
=== Ramifications ===
 
=== Ramifications ===
  
Une caractéristique importante de Git, est qu'il est extrêmement facile de travailler avec des branches, et, les fusionner. La meilleure pratique recommande de créer une nouvelle branche à chaque fois que vous voulez travailler sur une nouvelle fonctionnalité.
+
Au lieu de travailler sur la version principale du code, les meilleures pratiques avec Git recommandent de créer une nouvelle branche chaque fois que vous souhaitez travailler sur une nouvelle fonctionnalité. Les branches sont peu coûteuses en ressources, elles ne copient pas l’ensemble de l’arborescence des sources, mais créent simplement un point dans le temps sur lequel vous allez écrire du code; ainsi, les branches aident à garder le travail en cours séparé du code principal.
 +
 
 +
L'ajout d'une nouvelle branche est réalisée en 2 étapes : Tout d'abord vous créez la branche, puis vous vous commutez sur celle-ci.
 +
 
 +
{{Code|code=
 +
git branch myNewBranch
 +
git checkout myNewBranch
 +
}}
 +
 
 +
Sinon, effectuez les deux étapes avec une seule instruction:
 +
 
 +
{{Code|code=
 +
git checkout -b myNewBranch
 +
}}
 +
 
 +
Maintenant, vous pouvez changer de branche avec {{incode|checkout}} chaque fois que vous avez besoin de travailler dessus. Pour afficher les branches de votre projet et de la branche actuelle, utilisez l'opération {{incode|branch}} seule ou ajoutez {{incode|-v}} ou {{incode|-vv}} pour plus d'informations:
  
Création d'une branche se fait avec :
+
{{Code|code=
git branch myNewBranch
+
git branch
git checkout myNewBranch
+
git branch -vv
ou, les deux opérations en un seule :
+
}}
git checkout -b myNewBranch
 
vous pouvez toujours vérifier, dans quelle branche vous êtes avec :
 
git branch
 
  
=== Soumettre ===
+
Une fois que vous avez effectué les changements et que vous les avez validés (commit), utilisez la ligne de commande {{incode|log}} avec les options suivantes pour visualiser les branches.
  
Une fois que vous avez fait un peu de travail, validez le avec :
+
{{Code|code=
<pre>git commit -a</pre>
+
git log --oneline --decorate --graph --all
Contrairement à [http://fr.wikipedia.org/wiki/Apache_Subversion SVN], vous devez informer avec précision les fichiers à envoyer (ou la totalité avec l'option '''-a'''). Votre éditeur de texte s'ouvrira, pour vous permettre d'écrire un message de validation.
+
}}
  
=== Publishing your work on your GitHub repository===
+
=== Validation des modifications ===
{{Note|Important Note|If you have code you wish to see merged into the FreeCAD source code, please post a note in the Pull Request section of the FreeCAD forum}}
+
 
After you're correctly branched made some modifications to your local branch and commit them 'locally', you can push your repository to your remote git server (in this example we're assuming GitHub). This opens your branch to the public and allows the main developers to review and integrate your branch into ''master''.  
+
Une fois que vous êtes dans une nouvelle branche, éditez les fichiers sources que vous voulez avec votre éditeur de texte. Pour voir quels fichiers ont été modifiés, utilisez la commande {{incode|status}} et {{incode|diff}}; Lorsque que vous êtes satisfait de votre travail, validez le avec la commande {{incode|commit}} :
git push  <REMOTENAME> <BRANCHNAME>
+
 
git push origin my-branch
+
{{Code|code=
<small>For further info on this subject please read https://help.github.com/articles/pushing-to-a-remote/</small>
+
git status
 +
git diff
 +
git commit -a
 +
}}
 +
 
 +
Contrairement à SVN, vous devez indiquer précisément les fichiers à valider. utilisez l'option {{incode|-a}} pour enregistrer les modifications dans tous les fichiers modifiés. Votre éditeur de texte, par exemple, {{incode|nano}} ou {{incode|vim}}, s'ouvrira pour vous permettre d'écrire un message de validation.
 +
 
 +
Alternativement, ajoutez le message dans le "commit" lui-même:
 +
 
 +
{{Code|code=
 +
git commit -a -m "Fix the bug in the clone function."
 +
}}
 +
 
 +
Si vous créez de nouveaux fichiers ou répertoires, vous devez d'abord utiliser l'opération {{incode|add}} pour les ajouter au référentiel local avant de valider les modifications.
 +
 
 +
{{Code|code=
 +
git add path
 +
git commit -a
 +
}}
 +
 
 +
Où {{incode|path}} peut être n'importe quel répertoire ou fichier.
  
 
=== Rédaction de bons messages de commit ===
 
=== Rédaction de bons messages de commit ===
 +
Vous devriez essayer de travailler en petites sections. Si vous ne pouvez pas résumer vos modifications en une seule phrase, il y a probablement trop longtemps, que vous avez fait un commit.
  
Vous devriez essayer de travailler en petites sections. Si vous ne pouvez pas résumer vos modifications en une seule phrase, il y a probablement trop longtemps, que vous avez fait un commit. Il est également important de donner une descriptions détaillée, et, utile de votre travail. Pour les messages de commit, FreeCAD a adopté un format qui est mentionné dans le livre [[#Lecture complémentaire|Git Pro]].
+
Pour les grands changements, il est important que vous disposiez de descriptions utiles et utiles de votre travail. FreeCAD a adopté un format mentionné dans le livre [https://git-scm.com/book/en/v2 Pro Git], qui consiste en un court message, puis en un paragraphe descriptif plus grand.
  
  Court sommaire des changements (50 caractères ou plus)
+
{{Code|code=
 +
Court sommaire des changements (50 caractères ou plus)
  
 
  Si nécessaire, bien détailler les textes explicatifs. Ecrivez-en environ 72 caractères ou plus.
 
  Si nécessaire, bien détailler les textes explicatifs. Ecrivez-en environ 72 caractères ou plus.
Line 123: Line 226:
  
 
  Les paragraphes supplémentaires, viennent après les lignes vides.
 
  Les paragraphes supplémentaires, viennent après les lignes vides.
  * Les puces sont très bien aussi
+
 
 +
  - Les puces sont très bien aussi
 +
 
 
  - En général, un trait d'union ou un astérisque est utilisé pour la puce, précédé d'un
 
  - En général, un trait d'union ou un astérisque est utilisé pour la puce, précédé d'un
 
   espace unique, avec des lignes blanches entre les deux, mais ici les conventions varient.
 
   espace unique, avec des lignes blanches entre les deux, mais ici les conventions varient.
 +
}}
 +
 +
Si vous effectuez de nombreux travaux connexes dans une branche, vous devez effectuer de nombreux petits commits (voir un [https://forum.freecadweb.org/viewtopic.php?f=10&t=2062&p=14887#p14886 forum post]) . Lorsque vous souhaitez fusionner ces modifications dans la branche principale, vous devez émettre
 +
 +
{{Code|code=
 +
git log master..myNewBranch
 +
}}
 +
 +
pour voir les messages individuels de commit. Vous pouvez ensuite écrire un message de haute qualité lors d’une fusion.
 +
 +
Lorsque vous fusionnez pour maîtriser, utilisez l'option {{incode|--squash}} et validez avec votre message de validation de qualité. Cela vous permettra d'être très libéral avec vos commits et vous aidera à fournir un bon niveau de détail dans les messages de validation sans autant de descriptions distinctes.
 +
 +
=== Regroupement des "commits" ===
 +
 +
Il est possible de regrouper plusieurs "commits" consécutifs dans 1 seul "commit", on appelle ça le "squashing". Ceci peut être utile dans les cas où vous avez effectué beaucoup de "petits commits" et que vous souhaitez les regrouper dans un seul "commit". Par exemple, lorsque vous changez simplement une variable, que vous corrigez des erreurs d'orthographe ou que vous ajustez la mise en forme de votre code. Vous devez faire des regroupements uniquement sur des "petits commits". Les grandes modifications effectuées sur plusieurs fichiers doivent contenir l'ensemble de l'historique des changements du commit.
 +
 +
Avec la commande {{incode|git log --oneline}}, vous pouvez voir plusieurs "commits" consécutifs dont le plus récent est situé en haut de la liste. Dans cet exemple, plusieurs "commits" ont été effectués à partir de la "fonctionnalité A" pour réaliser l'implémentation de la "fonctionnalité B"; Nous souhaiterions maintenant regrouper tous les "commits" effectués pour la "fonctionnalité B" en un seul.
 +
 +
{{Code|code=
 +
871adb OK, feature B is fully implemented
 +
1c3317 Whoops, it is not ready yet...
 +
87871a I'm almost ready!
 +
643d0e Code cleanup
 +
af2581 Fix this and that
 +
4e9baa Good implementation
 +
d94e78 Prepare the module for feature B
 +
6394da Feature A
 +
}}
 +
 +
Utilisez la commande {{incode|rebase}} avec l'option {{incode|--interactive}} ou {{incode|-i}} pour sélectionner différents "commits" et les regrouper en un seul. Utilisez la valeur de hachage située juste devant le premier commit que vous voulez regrouper. Dans notre cas, il s'agit de celui qui correspond à la "fonctionnalité A".
 +
 +
{{Code|code=
 +
git rebase -i 6394da
 +
}}
 +
 +
un éditeur de ligne de commande comme {{incode|nano}} ou {{incode|vim}} s'ouvrira pour vous montrer les "commits", mais cette fois avec le plus ancien en haut de la liste. Avant chaque "commit", le mot {{incode|pick}} sera affiché. Supprimez le mot {{incode|pick}}, et écrivez le mot {{incode|squash}} ou juste la lettre {{incode|s}} à la place, à l'exception de la première entrée; Ce "commit" est le plus ancien, donc tous les futurs "commits" seront regroupés dans celui-ci.
 +
 +
{{Code|code=
 +
pick d94e78 Prepare the module for feature B
 +
s 4e9baa Good implementation
 +
s af2581 Fix this and that
 +
s 643d0e Code cleanup
 +
s 87871a I'm almost ready!
 +
s 1c3317 Whoops, it is not ready yet...
 +
s 871adb OK, feature B is fully implemented
 +
}}
 +
 +
Sauvegardez le fichier et fermez l'éditeur.
 +
 +
L'éditeur s'ouvrira de nouveau. Vous pouvez maintenant ajouter un long message qui décrira tous les changements effectués comme s'ils étaient réunis dans un seul "commit". Sauvegardez le fichier et fermez l'éditeur une fois de plus. Ceci finira l'action de regroupement de ces "commits" avec le nouveau message que vous avez saisis.
 +
 +
Vous pouvez encore utiliser {{incode|git log --oneline}} pour observer le nouvel historique des changements du commit. Dans ce cas, seul un simple "commit" pour la "fonctionnalité B", apparaitra au dessus du "commit" non modifié pour la "fonctionnalité A".
 +
 +
{{Code|code=
 +
c83d67 OK, feature B is fully implemented now, with proper module setup, and clean code.
 +
6394da Feature A
 +
}}
 +
 +
=== Publication de votre travail sur votre dépôt GitHub ===
 +
 +
Les branches locales de votre ordinateur ne sont pas automatiquement synchronisées avec les serveurs distants que vous avez spécifiés comme {{incode|origine}} ou {{incode|en amont}} (voir [[#Référentiels distants|Référentiels distants]]); vous devez explicitement pousser les branches sur les serveurs distants, pour lesquels vous devez avoir un accès en écriture. Une fois que cela est fait, les branches deviennent publiques et disponibles pour être revues par d'autres développeurs.
 +
 +
Pour FreeCAD, vous devez placer votre branche locale dans le référentiel distant {{incode|origin}}, à savoir, {{URLn|https://github.com/GITHUB_USERNAME/FreeCAD}}. Vous devez entrer votre nom d'utilisateur et votre mot de passe chaque fois que vous appuyez, sauf si vous avez configuré [https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage#_credential_caching mise en cache]. Veuillez lire [https://help.github.com/articles/pushing-to-a-remote/ Pushing dans un référentiel distant] pour plus d'informations.
 +
 +
{{Code|code=
 +
git push origin myNewBranch
 +
}}
 +
 +
Lorsque vous travaillez avec une seule branche, vous devrez peut-être rebaser, écraser et corriger les commits plusieurs fois de manière interactive. Dans ce cas, votre historique de branche ne sera pas simple et vous ne pourrez pas le pousser vers le référentiel distant. Vous pouvez obtenir un message comme le suivant, indiquant qu'il n'est pas possible d'effectuer un push "fast-forward" (avance rapide).
 +
{{Code|code=
 +
error: failed to push some refs to 'https://github.com/USER/FreeCAD.git'
 +
hint: Updates were rejected because a pushed branch tip is behind its remote
 +
hint: counterpart. Check out this branch and integrate the remote changes
 +
hint: (e.g. 'git pull ...') before pushing again.
 +
hint: See the 'Note about fast-forwards' in 'git push --help' for details.
 +
}}
 +
 +
Pour pousser enfin votre branche vers le dépôt distant, vous devez la "forcer à la pousser". Cela remplacera complètement votre branche distante par la branche réelle que vous avez hors ligne.
 +
{{Code|code=
 +
git push -f origin myNewBranch
 +
}}
 +
 +
Le développeur standard n'a pas d'accès en écriture au référentiel {{incode|upstream}} {{URL|https://github.com/FreeCAD/FreeCAD}}. Par conséquent, vous ne devez jamais envoyer de code à ce serveur distant.
 +
 +
=== Rebasing de l'amont ===
 +
 +
Pendant que vous travaillez sur votre propre branche, le code officiel de FreeCAD continue de s'améliorer avec les "commits" des autres développeurs, ce qui créé une différence de contenu avec votre branche personnelle.
 +
 +
<!--NOT CHANGE THE <pre> </pre> BALISE CAUSE THE SPACE IN MACRO CODE IS NOT RESPECTED-->
 +
<pre>
 +
      .-----A origin/myNewBranch
 +
    /
 +
-----o-----------Z FreeCAD upstream/master
 +
</pre>
 +
 +
Par conséquent, lorsque vous êtes prêt à fusionner votre branche sur le dépôt principal de FreeCAD, vous devez faire un "rebase" (sorte de re-synchronisation) de votre copie du dépôt, afin que son contenu se rapproche le plus possible de celui du dépôt officiel. Voir le document [https://git-scm.com/book/en/v2/Git-Branching-Rebasing Git Branching - Rebasing] pour plus d'informations.
 +
 +
{{Code|code=
 +
git checkout myNewBranch
 +
git pull --rebase upstream master
 +
}}
 +
 +
Cette opération va télécharger le code à partir de la branche {{incode|master}} du dépôt {{incode|upstream}} (le code source officiel de FreeCAD), et va le fusionner avec celui de votre branche courante ({{incode|myNewBranch}}), afin que vos modifications apparaissent tout en haut de la liste du dernier code officiel. Si personne n'a réalisé de modifications dans les fichiers sur lesquels vous avez travaillés, la fusion se fera sans erreurs. Si certains fichiers ont été modifiés en même temps par des personnes différentes, il se peut qu'il y ait des conflits qui devront être résolus.
 +
 +
<!--NOT CHANGE THE <pre> </pre> BALISE CAUSE THE SPACE IN MACRO CODE IS NOT RESPECTED-->
 +
<pre>
 +
                  .-----A' origin/myNewBranch
 +
                /
 +
-----o-----------Z FreeCAD upstream/master
 +
</pre>
 +
 +
Pour résumer, vous devez être dans la branche appropriée, faire un "rebase" et puis un "push".
 +
 +
{{Code|code=
 +
git checkout myNewBranch
 +
git pull --rebase upstream master
 +
git push origin myNewBranch
 +
}}
 +
 +
L'opération {{incode|pull}} est équivalente à un {{incode|fetch}} (récupération) suivit d'un {{incode|merge}} (fusion). Lorsque l'option {{incode|--rebase}} est utilisée, à la place de faire un simple {{incode|merge}}, c'est l'opération {{incode|rebase}} qui sera exécutée.
 +
 +
{{Code|code=
 +
git pull upstream
 +
 +
git fetch upstream
 +
git merge FETCH_HEAD
 +
}}
 +
 +
{{Code|code=
 +
git pull --rebase upstream master
 +
 +
git fetch upstream
 +
git rebase master
 +
}}
 +
 +
=== Fusion de la branche (pull request) ===
 +
 +
Une fois que vous avez validé vos modifications, "mis à jour" votre branche à partir du dépôt principal et "poussé" votre branche sur le serveur, vous pouvez initier un "pull request". Un "[https://help.github.com/articles/about-pull-requests/ pull request]" informe les administrateurs du dépôt officiel de FreeCAD que vous souhaitez fusionner le nouveau code de votre branche avec le code officiel.
 +
 +
Dès que vous transmettez le code à votre référentiel {{incode|origin}} {{URLn|https://github.com/GITHUB_USERNAME/FreeCAD}}, GitHub vous offre la possibilité de comparer et de créer une demande d'extraction par rapport au Référentiel {{incode|upstream}}. En appuyant sur le bouton {{Button|Compare & pull request}}, vous ouvrirez une interface qui vous permettra de choisir quel référentiel est la "base", cible de la fusion, et quelle est la "tête", de votre code supplémentaire. Une vérification rapide sera effectuée par le système vous indiquant s'il n'y a pas de conflit avec les fichiers que vous avez modifiés; si vous avez travaillé sur des fichiers que personne n'a touchés, votre branche pourra fusionner proprement. De plus, il vous montrera un éditeur de texte afin que vous puissiez écrire un message documentant vos modifications. il affichera également le nombre de commits dans votre branche, le nombre de fichiers modifiés et une vue indiquant les différences entre la "base" et la "tête", afin que tout le monde puisse voir immédiatement les modifications que vous souhaitez apporter.
 +
 +
{{Code|code=
 +
base repository: FreeCAD/FreeCAD    base: master  <----  head repository: GITHUB_USERNAME/FreeCAD    compare: myNewBranch
 +
 +
Able to merge. These branches can be automatically merged.
 +
}}
 +
 +
Cliquez sur {{Button|Create pull request}} pour continuer. Un message apparaîtra indiquant que certaines vérifications doivent être effectuées sur le code. C'est un système qui compile automatiquement FreeCAD et exécute les tests unitaires. Si les tests réussissent, la demande d'extraction aura plus de chance d'être fusionnée dans le code principal, sinon un rapport sera généré indiquant les erreurs rencontrées. Voir [https://travis-ci.org/FreeCAD/FreeCAD/pull_requests FreeCAD].
 +
 +
<!--NOT CHANGE THE <pre> </pre> BALISE CAUSE THE PIPE OR SPACE IN MACRO CODE CUT THE MACRO-->
 +
<pre>
 +
Some checks haven’t completed yet
 +
 +
* continuous-integration/travis-ci/pr Pending — The Travis CI build is in progress  |Required|
 +
</pre>
 +
 +
Si les tests réussissent, vous verrez un message tel que le suivant
 +
 +
Tous les tests ont passés
 +
 +
<!--NOT CHANGE THE <pre> </pre> BALISE CAUSE THE PIPE OR SPACE IN MACRO CODE CUT THE MACRO-->
 +
<pre>
 +
* continuous-integration/travis-ci/pr — The Travis CI build passed  |Required|
 +
</pre>
 +
 +
Cette branche n'a pas de conflits avec la branche de base
 +
Seules les personnes ayant un accès en écriture à ce référentiel peuvent fusionner des demandes d'extraction.
 +
 +
Vous devez maintenant attendre que les administrateurs fusionnent votre branche. vous serez averti lorsque cela se produira.
 +
 +
{{Code|code=
 +
Pull request successfully merged and closed
 +
 +
You’re all set — the GITHUB_USERNAME:myNewBranch branch can be safely deleted.
 +
If you wish, you can also delete your fork of FreeCAD/FreeCAD.
 +
}}
 +
 +
Si vous le souhaitez, vous pouvez supprimer la branche qui vient d'être fusionnée, ou même votre branche entière de FreeCAD, car votre propre code est déjà inclus à la fin de la branche principale.
 +
 +
{{Code|code=
 +
-----o-----------Z----A' FreeCAD upstream/master
 +
}}
 +
 +
{{Emphasis|Note:}} vous pouvez continuer à travailler ({{incode|git commit -a}}) sur la même branche en attendant l'approbation de la fusion; si vous {{incode|git push}} à nouveau, une deuxième validation de fusion sera mise en file d'attente dans la même demande d'extraction, et un autre test automatisé sera effectué. En d’autres termes, même si vos administrateurs n’approuvent pas encore vos fusions, vous pouvez continuer à appliquer des modifications à votre référentiel {{incode|origin}}, ce qui mettra ces commits en file d'attente dans la même demande d'extraction du référentiel {{incode|en amont}}. L'utilisation d'une seule demande d'extraction pour mettre en file d'attente plusieurs commits individuels est souvent souhaitable pour de petites modifications. Pour les ajouts importants au code source, vous devez créer une autre branche, d'y développer vos fonctionnalités, puis soumettre une demande d'extraction distincte pour cette branche.
 +
 +
L'interface de requête d'extraction peut être utilisée chaque fois que vous souhaitez soumettre du code à partir de vos propres référentiels vers un autre référentiel de GitHub. Vous pouvez également l'utiliser pour fusionner du code dans la direction opposée, des branches d'autres personnes à la vôtre, ou même entre vos propres branches. Dans le dernier cas, puisque vous possédez les branches, les fusions peuvent être approuvées par vous-même immédiatement.
 +
 +
{{Code|code=
 +
base repository: SomeProject/Some_Software  base: master      <----  head repository: GITHUB_USERNAME/Some_Software  compare: add_new_functions
 +
base repository: GITHUB_USERNAME/FreeCAD    base: myNewBranch  <----  head repository: FreeCAD/FreeCAD                compare: master
 +
base repository: GITHUB_USERNAME/FreeCAD    base: myNewBranch  <----  head repository: GITHUB_USERNAME/FreeCAD        compare: fix-many-bugs-branch
 +
}}
 +
 +
=== Maintien du dépôt GitHub à jour ===
 +
 +
Une fois que vous avez créé FreeCAD, votre référentiel personnel existe indépendamment de l'original. Lorsque le référentiel d'origine comporte de nouveaux commits, GitHub vous informera que votre référentiel personnel est en retard sur le nombre de commits:
 +
 +
{{Code|code=
 +
This branch is 5 commits behind FreeCAD:master.
 +
}}
 +
 +
De la même manière, si vous avez créé une branche de développement avec un nouveau code, GitHub vous informera que cette branche est en avance en nombre de validations; c'est-à-dire que cette branche contient des modifications qui n'ont pas été fusionnées dans le référentiel officiel de FreeCAD:
 +
 +
{{Code|code=
 +
This branch is 3 commits ahead of FreeCAD:master.
 +
}}
 +
 +
Pendant le développement, les deux cas sont possibles, car votre propre branche peut ne pas avoir de commits faits par d’autres développeurs, mais inclure de nouveaux commits de votre part:
 +
 +
{{Code|code=
 +
This branch is 2 commits ahead, 14 commits behind FreeCAD:master.
 +
}}
 +
 +
Lors du développement du code, il est recommandé de rebaser la branche dans laquelle vous travaillez actuellement, car cela mettra votre branche toujours devant le code maître FreeCAD.
 +
 +
Quant à votre branche originale {{incode|master}}, elle ne sera jamais automatiquement mise à jour par GitHub; c'est quelque chose que vous devez faire vous-même. Passez à la branche {{incode|master}}, puis à {{incode|pull}} à partir de {{incode|amont}} qui effectue un {{incode|fetch}} et {{incode|fusion}},  puis poussez cette branche {{incode|master}} mise à jour vers votre référentiel {{incode|origine}} distant.
 +
 +
{{Code|code=
 +
git checkout master
 +
git pull upstream master
 +
git push origin master
 +
}}
 +
 +
Une fois cela fait, GitHub vous indiquera que vous êtes synchronisé avec le référentiel {{incode|upstream}}.
 +
 +
{{Code|code=
 +
This branch is even with FreeCAD:master.
 +
}}
 +
 +
Maintenant que votre {{incode|master}} est à jour, vous pouvez décider de le changer et de supprimer l’autre branche que vous avez utilisée précédemment pour développer une fonctionnalité.
 +
 +
{{Code|code=
 +
git checkout master
 +
git branch -d myNewBranch
 +
}}
 +
 +
Pour supprimer la branche du référentiel distant {{incode|origin}}, vous pouvez utiliser l'opération {{incode|push}}. Normalement, vous poussez une branche locale; cela crée une branche distante portant le même nom que votre branche locale.
 +
 +
{{Code|code=
 +
git push origin myNewBranch
 +
}}
 +
 +
Toutefois, si vous utilisez la notation {{incode|local_name:remote_name}}, la branche locale est créée dans le référentiel distant sous un nom différent:
 +
 +
{{Code|code=
 +
git push origin myNewBranch:someRemoteBranch
 +
}}
 +
 +
Par conséquent, vous pouvez supprimer la branche distante en poussant une branche locale vide:
 +
 +
{{Code|code=
 +
git push origin :myNewBranch
 +
git push origin :someRemoteBranch
 +
}}
 +
 +
Maintenant que vous ne disposez que d'un {{incode|master}} à jour, vous pouvez créer une nouvelle branche et répéter les étapes de modification de fichiers, de validation, d'insertion, de soumission d'une demande d'extraction, de fusion et de mise à jour.
 +
 +
{{Code|code=
 +
git checkout master
 +
git checkout -b anotherBranch
 +
}}
 +
 +
Si vous ne souhaitez pas supprimer votre branche déjà personnalisée, vous pouvez forcer la mise à jour pour correspondre à la valeur de la mise à jour {{incode|master}}; vous pouvez ensuite faire ce que vous voulez, y compris ajouter plus de commits et le pousser dans le référentiel distant {{incode|origin}}.
 +
 +
{{Code|code=
 +
git checkout myNewBranch
 +
git reset --hard master
 +
git push -f origin myNewBranch
 +
}}
 +
 +
Réinitialiser une branche comme ceci n’est généralement pas nécessaire. Dans la plupart des cas, vous souhaitez suivre la séquence de création d'une nouvelle branche, de validation des modifications, de transmission de ces modifications, de fusion de la branche, puis de suppression de la branche.
 +
 +
== Opérations git avancées ==
 +
 +
=== Rechercher ===
 +
 +
Quelques outils pratiques pour vous aider à trouver ce que vous cherchez:
 +
 +
==== Rechercher les noms de fichiers ====
 +
 +
Utilisez {{incode|git ls-files}} pour rechercher dans le dépôt un fichier contenant une certaine chaîne dans un nom de fichier. L'exemple ci-dessous renverra toutes les instances des fichiers contenant 'dxf' dans leurs noms de fichiers.
 +
 +
{{Code|code=
 +
git ls-files *dxf*
 +
}}
 +
 +
 +
==== Rechercher une chaîne ====
 +
 +
Utilisez {{incode|git grep}} pour rechercher dans le dépôt un fichier contenant une certaine chaîne avec les fichiers eux-mêmes. L'exemple ci-dessous renverra toutes les instances des fichiers qui contiennent 'dxf' dans chaque fichier.
 +
 +
{{Code|code=
 +
git grep dxf
 +
}}
 +
 +
 +
=== Résolution des conflits de fusion ===
 +
 +
La fusion de branches avec {{incode|git merge}} ou la redistribution de votre branche avec {{incode|git rebase}} présente parfois des conflits de fichiers pouvant avoir été modifiés par un autre auteur en même temps. Si cela se produit, vous devriez voir les modifications des deux côtés, de l'autre auteur et du vôtre, puis décider de la meilleure façon d'inclure les deux ensembles de modifications. Ceci est normalement un processus manuel qui ne peut pas être automatisé; le programmeur doit comprendre le code et décider du code à déplacer, réécrire ou abandonner pour résoudre le conflit.
 +
 +
Lorsqu'un conflit survient, un message comme celui-ci peut apparaître.
 +
 +
{{Code|code=
 +
CONFLICT (content): Merge conflict in src/Mod/source_code.py
 +
error: Failed to merge in the changes.
 +
Patch failed at 1234 Some commit message when editing source_code.py
 +
}}
 +
 +
Si un outil de différenciation spécialisé est installé et configuré pour Git, par exemple, celui de Gnome [https://wiki.gnome.org/Apps/Meld Meld], le conflit peut être examiné et résolu en utilisant l'opération {{incode|mergetool}}..
 +
 +
{{Code|code=
 +
git mergetool
 +
}}
 +
 +
L'outil de fusion affiche normalement trois colonnes; les deux colonnes sur les côtés affichent les deux fichiers en conflit, tandis que la colonne du milieu affiche le nouveau code qui sera enregistré et finalement validé. Par conséquent, cette colonne centrale doit être modifiée de manière à intégrer le code des deux colonnes latérales. Une fois le conflit résolu et le nouveau code source (la colonne centrale) enregistré, vous pouvez fermer l’outil de fusion. Ensuite, l'opération {{incode|merge}} ou {{incode|rebase}} peut continuer.
 +
 +
{{Code|code=
 +
git merge --continue
 +
git rebase --continue
 +
}}
 +
 +
Pour plus d'informations sur la fusion et la résolution des conflits, voir:
 +
* [https://git-scm.com/docs/git-merge#_how_conflicts_are_presented explications git-scm sur la manière dont les conflits sont présentés] avec {{incode|git merge}}.
 +
* [https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging#_basic_merge_conflicts Conflits de fusion élémentaires] et [https://git-scm.com/book/en/v2/Git-Tools-Advanced-Merging Outils Git - Fusion avancée]
 +
* [https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ Article de GitHub sur la résolution des problèmes de fusion par la ligne de commande].
 +
* [https://git-scm.com/book/fr/v2/Customizing-Git-Git-Configuration#_external_merge_tools Personnalisez votre outil de fusion préféré] lorsque vous rencontrez un conflit entre plusieurs git.
 +
 +
=== Inspecter les changements ===
 +
 +
Inspectez l'historique des modifications apportées à un fichier qui a subit plusieurs "commits" avec l'opération {{incode|log}}:
 +
 +
{{Code|code=
 +
git log --patch path
 +
}}
 +
 +
Où {{incode|path}} peut être n'importe quel répertoire ou fichier. Au lieu de {{incode|--patch}}, vous pouvez également utiliser les raccourcis {{incode|-p}} ou {{incode|-u}}.
 +
 +
=== Inspecter les changements entre deux branches ===
 +
 +
Inspectez les modifications entre deux branches avec les opérations {{incode|log}} et {{incode|diff}} avec les noms des branches:
 +
 +
{{Code|code=
 +
git log master..myBranch
 +
git diff master..myBranch
 +
}}
 +
 +
L'opération {{incode|log}} affiche les validations, tandis que {{incode|diff}} indique les modifications réelles apportées aux fichiers.
 +
 +
=== Réinitialiser les fichiers et les répertoires ===
 +
 +
Si vous avez accidentellement apporté des modifications à un fichier ou à un répertoire, vous souhaiterez peut-être annuler complètement ces modifications pour obtenir l'état précédent du code source.
 +
 +
Cela peut être fait rapidement en utilisant l'opération {{incode|checkout}}:
 +
 +
{{Code|code=
 +
git checkout path
 +
git checkout .
 +
}}
 +
 +
Cela restaurera le {{incode|path}} (un fichier ou un répertoire) à l'état dans lequel il se trouve à l'extrémité de la branche, en ignorant les modifications qui n'ont pas été validées. Si {{incode|path}} est le point unique {{incode|.}}, Tous les fichiers du répertoire en cours seront restaurés.
 +
 +
Si vous avez accidentellement ajouté des fichiers et des répertoires, vous pouvez utiliser l'opération {{incode|clean}}:
 +
 +
{{Code|code=
 +
git clean -df
 +
}}
 +
 +
Ceci forcera la suppression de tous les fichiers et répertoires ({{incode|-df}}) qui ne font pas l'objet d'un suivi par le référentiel, c'est-à-dire ceux qui n'ont pas été inclus précédemment avec l'opération {{incode|add}}.
 +
 +
Pour réinitialiser complètement le référentiel en perdant toutes les modifications non validées, utilisez l'opération {{incode|reset}}:
 +
 +
{{Code|code=
 +
git fetch
 +
git reset --hard FETCH_HEAD
 +
}}
 +
 +
Où {{incode|FETCH_HEAD}} est la pointe du référentiel {{incode|upstream}}. Un autre commit peut également être utilisé.
 +
 +
L'opération {{incode|revert}} annule également les modifications. Cependant, cette commande fait cela en ajoutant un autre commit à l'historique; dans de nombreux cas, cela n'est pas souhaité.
 +
 +
=== Taille des vieilles branches ===
 +
 +
Si vous avez engagé de nombreuses branches dans le référentiel {{incode|upstream}}, vous souhaiterez peut-être supprimer ces branches de votre système local car elles ont déjà été fusionnées. La branche en ligne du référentiel {{incode|origin}} peut être supprimée immédiatement après la fusion. Ensuite, vous pouvez supprimer les références locales à cette branche en utilisant les options {{incode|--prune}} ou {{incode|prune}} pour les opérations {{incode|fetch}} et {{incode|remote}}.
 +
 +
{{Code|code=
 +
git fetch --prune origin
 +
git remote prune origin
 +
}}
 +
 +
Enfin, vous pouvez supprimer les branches localement
 +
 +
{{Code|code=
 +
git branch -D myBranch
 +
}}
 +
 +
Après un certain temps, il est également recommandé de procéder à la récupération d'espace disque, en utilisant l'opération {{incode|gc}}. Cela supprimera les fichiers inutiles et compressera les révisions de fichiers locaux, afin d'optimiser l'utilisation du disque local du référentiel.
 +
 +
{{Code|code=
 +
git gc
 +
}}
 +
 +
=== Travailler avec des patchs ===
 +
 +
Bien que Git vous permette de fusionner le code de différentes branches localement sur votre ordinateur via la commande {{incode|git merge}} ou d'effectuer un "pull request" sur le serveur distant (remote repository), il est parfois préférable de créer un patch qui peut être envoyé en tant que pièce jointe par e-mail au lieu de soumettre un PR. Le flux de travail suivant explique comment procéder:
 +
 +
=== Création de correctifs ===
 +
 +
* Il est conseillé de travailler dans une nouvelle branche et non pas directement sur la branche master de votre dépôt. La première étape consiste donc à s'assurer que vous êtes dans la bonne branche et le cas échéant à s'y raccorder. Les commandes suivantes permettent de réaliser ces opérations :
 +
 +
{{Code|code=
 +
git branch -v
 +
git checkout myBranch
 +
}}
 +
 +
* Maintenant, utilisez la commande {{incode|git format-patch}} et l'option {{incode|--stdout}} pour envoyer le résultat vers la sortie standard STDOUT (Ecran); le résultat sera ensuite redirigé vers un fichier qui par commodité sera créé dans un dossier de niveau supérieur à celui du code source.
 +
 +
{{Code|code=
 +
git format-patch master --stdout > ../myCode.patch
 +
}}
 +
 +
* Une autre méthode
 +
 +
{{Code|code=
 +
git format-patch HEAD^
 +
git format-patch HEAD~1
 +
}}
 +
 +
Le nombre d'accents circonflexes {{incode|^}} ou le nombre situé derrière le tilde ~ {{incode|1}} indique le nombre de "commits" qui devront être considérés, à savoir par exemple {{incode|^^^}} ou {{incode|~3}} va créer 3 correctifs pour 3 "commits".
 +
 +
{{Code|code=
 +
git format-patch HEAD^
 +
}}
 +
 +
Cette commande va créer un "patch" ou une série de "patchs" en respectant la convention de nommage suivante :
 +
 +
{{Code|code=
 +
XXXX-commit-message.patch
 +
}}
 +
 +
où {{incode|XXXX}} est un nombre compris entre {{incode|0000}} et {{incode|9999}}, et où le message du "commit" forme la majorité du nom du fichier, par exemple :
 +
 +
{{Code|code=
 +
0001-fix-ViewProjMatrix-getProjectionMatrix.patch
 +
}}
 +
 +
=== Application des correctifs ===
 +
 +
Git a la capacité de fusionner des correctifs/diffs. Pour en savoir plus à ce sujet, lisez la référence suivante: [https://www.drupal.org/node/1399218 Application des patches avec Git]
 +
 +
Si vous avez déjà le fichier du correctif dans votre système, il suffit juste de l'appliquer.
 +
 +
{{Code|code=
 +
git apply myCode.patch
 +
}}
 +
 +
Vous pouvez utiliser {{incode|curl}} pour télécharger un correctif depuis un site web, et ensuite l'appliquer via la commande {{incode|git}}.
 +
 +
{{Code|code=
 +
curl -O https://some.website.org/code/myCode.patch
 +
git apply myCode.patch
 +
}}
 +
 +
Conseil utile: ajoutez simplement .diff ou .patch à la fin de l'URL d'une page de validation GitHub, d'une demande d'extraction ou d'une vue de comparaison et vous obtiendrez une vue de cette page. Exemple:
 +
* Page GitHub pour un "commit classique" : {{URL|https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621}}
 +
* Page GitHub pour un "Diff" : {{URL|https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.diff}}
 +
* Page GitHub pour un correctif : {{URL|https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch}}
 +
 +
Vous pouvez pointer {{incode|curl}} vers le "commit" d'un correctif particulier dans un dépôt, et le faire suivre directement vers {{incode|git}} pour appliquer le correctif.
 +
 +
<pre>
 +
curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -
 +
</pre>
 +
 +
=== Inverser un patch ===
 +
 +
Lorsque vous appliquez un correctif, vous modifiez certains fichiers. Cependant, ces modifications ne sont pas permanentes tant que vous n'avez pas validé les modifications. Par conséquent, si vous souhaitez rétablir un correctif, utilisez les instructions suivantes.
 +
 +
Cette commande annulera les modifications qui ont été appliquées, si vous avez toujours accès au fichier original du correctif:
 +
 +
{{Code|code=
 +
git apply -R myCode.patch
 +
}}
 +
 +
Cette commande alternative enlèvera toutes les modifications non validées dans la branche.
 +
 +
{{Code|code=
 +
git checkout -f
 +
}}
 +
 +
== Stockage temporaire dans le cache des git commits ==
 +
 +
Supposons que vous travaillez sur une branche et que vous apportiez des modifications à la source qui sortent du cadre de votre branche actuelle; autrement dit, ces changements seraient meilleurs dans une autre branche que dans la branche actuelle. La commande {{incode|git stash}} peut être utilisée pour stocker temporairement ces modifications locales non validées.
 +
 +
{{Code|code=
 +
git stash
 +
}}
 +
 +
Si à l'avenir vous souhaitez utiliser ces commits, vous pouvez les ''extraire'' de la réserve puis dans votre branche active.
 +
 +
{{Code|code=
 +
git stash pop
 +
}}
 +
 +
Ou si vous décidez que vous n'aimez plus ces commits sauvegardés, vous pouvez les supprimer complètement de la réserve.
  
Si vous faites beaucoup de travaux connexes, il a été suggéré '''[http://forum.freecadweb.org/viewtopic.php?f=10&t=2062&p=14887#p14886 ici]''', que l'on doit faire autant de commits que possible, grand ou petit, dans le sens que vous utilisez des messages avec de courtes phrases.
+
{{Code|code=
Lorsque vous souhaitez faire une fusion, faites un journal '''log master git .. BRANCH''', et, utilisez la sortie comme une base, pour la qualité de votre commit message.
+
git stash drop
Ensuite, lorsque vous effectuez la fusion, utilisez l'option '''--squash''', et, engagez avec le message de validation (commits) de qualité.
+
}}
Cela vous permettra d'être très libéral avec votre '''commit''', et, aidez à assurer un bon niveau de détails des messages de '''commit''' sans faire trop de descriptions distinctes.
 
  
== Advanced git operations ==
+
Vous pouvez lister plusieurs commits stash avec
=== Resolving Merge Conflicts ===
 
* [https://git-scm.com/docs/git-merge#_how_conflicts_are_presented git-scm explanation on how conflicts are presented]
 
* [https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ GitHub article on resolving merge conflicts via the command-line]
 
* [https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_external_merge_tools Customize your preferred merge tool] when you encounter a git conflict.
 
  
=== Applying patches via git ===
+
{{Code|code=
Git has the capability to merge patches/diffs. To read more about this read the following reference: https://www.drupal.org/node/1399218
+
git stash list
* Useful tip:  Just add .diff or .patch at the end of the URL for a GitHub commit page, Pull Request, or Compare View and it'll show you the plaintext view of that page. Example:
+
}}
Regular GitHub page:
 
<small>https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621</small>
 
  
'Diffed' GitHub page:
+
Pour en savoir plus, lisez [https://medium.freecodecamp.org/useful-tricks-you-might-not-know-about-git-stash-e8a9490f0a1a Useful tricks you might not know about Git stash].
<small>https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.diff</small>
 
  
'Patched' GitHub page:
+
=== Vérifier sur GitHub les demandes locales ===
<small>https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch</small>
 
  
==== Apply a patch via curl ====
+
[https://gist.github.com/piscisaureus/3342247 Checkout GitHub pull requests locally]
curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -
 
  
== Alternative repositories ==
 
The beauty of git is that everybody can clone a project, and start modifying the code. Several frequent collaborators of the FreeCAD project have their own git repository, where they build up their work before it is ready to be included in the official source code, or simply where they experiment new ideas. In certain cases, you might want to clone your FreeCAD code from one of these, instead of the official repos, to benefit from the changes their users did.
 
  
Be warned, though, that this is at your own risk, and only the official repository above is fully guaranteed to work and contain clean code.
+
=== Blâme ===
  
Il est également possible de lier plusieurs dépôts distants avec un seul code local, en utilisant la commande "git remote". C'est pratique pour rester synchronisé avec la branche "master", mais gardez un œil sur le travail des différents dévelopers.
+
{{VeryImportantMessage|Section TBD}}
  
== Using git in a Graphical User Interface ==
+
Ajouter du contenu depuis https://forum.freecadweb.org/viewtopic.php?f=23&t=55943&p=481483#p481287
* [[Developing FreeCAD with GitKraken]]
+
 
 +
== Numéro de révision FreeCAD ==
 +
 
 +
Contrairement à Subversion qui incrémente le numéro de révision, Git génère une [https://en.wikipedia.org/wiki/SHA-1 valeur de hachage SHA-1] à chaque "commit". Une valeur de hachage est une longue chaîne de caractères alphanumériques qui ressemble à ceci :
 +
 
 +
{{Code|code=
 +
9b3ffef570596e184006287434fba54a4b03ccc3
 +
}}
 +
 
 +
=== Quelle est la dernière révision de FreeCAD Dev ? ===
 +
 
 +
Pour trouver le dernier numéro de révision d'une branche particulière, utilisez l'opération {{incode|rev-list}} avec l'option {{incode|--count}}. Donnez le nom de la branche, du référentiel distant, de la balise ou un pointeur spécial tel que {{incode|HEAD}}, pour indiquer le dernier commit dans cet objet particulier.
 +
 
 +
{{Code|code=
 +
git rev-list --count master
 +
git rev-list --count HEAD
 +
git rev-list --count origin
 +
}}
 +
 
 +
ou parcourez [https://github.com/FreeCAD/FreeCAD le dépôt sur GitHub] et lisez le nombre de mises à jour (commits) effectuées dans la branche correspondante.
 +
 
 +
=== Quel est le numéro de révision correspondant à la valeur de hachage d'un "commit" ? ===
 +
 
 +
Comme la valeur de hachage est une chaîne de caractères alphanumériques, il n'est pas très utile de savoir si un "commit" est plus ancien ou plus récent qu'un autre. Pour trouver le numéro de révision correspond à une valeur de hachage particulière, utilisez à nouveau l'opération {{incode|rev-list}}; l'entrée peut être la valeur de hachage complète ou une valeur de hachage partielle qui est unique, généralement les 7 premiers chiffres sont suffisants.
 +
 
 +
{{Code|code=
 +
git rev-list --count ab1520b872821414c6ce4a15fb85d471ac2a2b03
 +
git rev-list --count 9948ee4
 +
}}
 +
 
 +
=== Quel est la valeur de hachage correspondante au numéro de révision d'un "commit" ? ===
 +
 
 +
Si nous avons un "commit" qui porte le numéro 15000 et que nous voulons trouver la valeur de hachage correspondante, nous allons avoir besoin de calculer le nombre de "commits" réalisés entre ce "commit" et le dernier "commit" ({{incode|HEAD}}). Dans un premier temps, cherchons le numéro du dernier "commit".
 +
 
 +
{{Code|code=
 +
git rev-list --count HEAD
 +
17465
 +
}}
 +
 
 +
Puis, soustrayons à ce résultat le "commit" que nous voulons.
 +
 
 +
{{Code|code=
 +
17465 - 15000 = 2465
 +
}}
 +
 
 +
Puis, utilisez la commande {{incode|log}} pour afficher la liste des "commits" et des valeurs de hachage. L'option {{incode|--skip}} permet de sauter la différence dans les "commits" que nous avons calculez, ce qui nous permet d'aller directement à la valeur de hachage que nous recherchons.
 +
 
 +
{{Code|code=
 +
git log --skip=2465
 +
commit 44c2f19e380e76b567d114a6360519d66f7a9e24
 +
}}
 +
 
 +
Il se peut que le résultat vous affiche 2 "commits" assez proches, confirmez que ce soit le bon numéro de "commit". Si ce n'est pas le cas, choisissez simplement le prochain "commit" dans la séquence (avant ou après) et vérifiez à nouveau.
 +
 
 +
{{Code|code=
 +
git rev-list --count 44c2f19e38
 +
15000
 +
}}
 +
 
 +
* [https://forum.freecadweb.org/viewtopic.php?f=10&t=26673 Show the commits] juste avant un commit particulier dans GitHub: dans la barre d’adresse du navigateur, changez le mot {{incode|commit}} par {{incode|commits}} pour afficher la liste.
 +
* [https://forum.freecadweb.org/viewtopic.php?t=5308 Trouver le numéro de révision du commit]
 +
* [https://forum.freecadweb.org/viewtopic.php?f=18&t=12883&p=103207#p103203 Trouver le numéro de révision du commit]
 +
* [https://forum.freecadweb.org/viewtopic.php?f=10&t=31118 Recherche de la valeur de hachage correspondante pour un numéro de validation particulier]
 +
 
 +
=== Comment le numéro de révision dans l'aide de FreeCAD est-il généré ? ===
 +
 
 +
Le numéro de version qui apparait avec l'outil [[Std_About/fr|Std About]] est définit dans le fichier {{incode|src/Build/Version.h}}, qui est créé au moment de la compilation lorsque l'outil {{incode|cmake}} est exécuté. Lisez le post [https://forum.freecadweb.org/viewtopic.php?f=4&t=3025 Extract version number from git source] pour plus d'informations.
 +
 
 +
== Ajout d'autres référentiels (distants) ==
 +
 
 +
Plusieurs collaborateurs du projet FreeCAD ont leurs propres référentiels Git où ils développent leur travail où ils expérimentent de nouvelles idées avant d'être prêts à être inclus dans le code source officiel. Vous voudrez peut-être obtenir leurs sources afin de tester leur code vous-même lorsqu'ils font une demande d'extraction.
 +
 
 +
Utilisez la commande {{incode|git remote}} pour ajouter ces autres référentiels afin que vous puissiez {{incode|fetch}} (récupérer) et {{incode|pull}} (pousser) suivre leurs codes.
 +
 
 +
{{Code|code=
 +
git checkout master
 +
git remote add OTHER_USER OTHER_URL
 +
git fetch OTHER_USER
 +
git checkout -b OTHER_BRANCH OTHER_USER/OTHER_BRANCH
 +
}}
 +
 
 +
Par exemple, ajoutons le dépôt de Bernd:
 +
{{Code|code=
 +
git remote add bernd http://github.com/berndhahnebach/FreeCAD_bhb
 +
}}
 +
La commande {{incode|git fetch}} télécharge les références à partir de ce dépôt distant.
 +
{{Code|code=
 +
git fetch bernd
 +
}}
 +
Répertoriez toutes les branches de votre propre dépôt et celles de vous avez ajoutées. Les branches de Bernd s'afficheront sous la forme {{incode|remotes/bernd/<branchname>}}.
 +
{{Code|code=
 +
git branch -a
 +
}}
 +
Maintenant, regardons une liste résumée des 10 derniers commits de la branche {{incode|femdev}} de Bernd.
 +
{{Code|code=
 +
git log -10 --oneline remotes/bernd/femdev
 +
}}
 +
Maintenant, nous pouvons vérifier la branche à inspecter.
 +
{{Code|code=
 +
git checkout remotes/bernd/femdev
 +
}}
 +
Ensuite, nous pouvons créer une branche locale basée sur la branche distante. Cette branche locale, nous pouvons la modifier et y ajouter notre propre code.
 +
{{Code|code=
 +
git checkout -b local_branch_name /remotes/bernd/femdev
 +
}}
 +
 
 +
Vous pouvez souhaiter {{incode|git rebase}} la branche nouvellement obtenue sur la branche {{incode|upstream/master}} pour vous assurer qu'elle utilise le dernier code. S'il y a des conflits, ils devront être résolus à ce stade.
 +
{{Code|code=
 +
git pull --rebase upstream master
 +
}}
 +
 
 +
La nouvelle branche est prête à être modifiée et compilée comme décrit dans [[Compiling/fr|Compiler]].
 +
 
 +
Dirigez vous vers la section de développement du [https://forum.freecadweb.org/viewforum.php?f=6 forum FreeCAD] pour discuter du développement.
  
 
== Lecture complémentaire ==
 
== Lecture complémentaire ==
  
* [http://spheredev.org/wiki/Git_for_the_lazy Git for the lazy]
+
* [[Developing FreeCAD with GitKraken/fr|Développer FreeCAD avec GitKraken]], un guide pour utiliser l'interface graphique avec Git.
* [http://progit.org/book/ Git pro on-line book]
+
* [https://wiki.spheredev.org/index.php/Git_for_the_lazy Git pour les paresseux], un guide très concis des principales commandes de {{incode|git}}.
 
+
* Le [https://git-scm.com/book Pro Git book] livre open source vous enseignant Git; il est disponible en versions électronique et imprimée.
[[Category:Hubs/fr]]
+
* Le [https://marklodato.github.io/visual-git-guide Visual Git guide], une référence avec des diagrammes expliquant les opérations les plus courantes avec Git.
[[Category:Developer Documentation/fr]]
+
* [https://www.youtube.com/watch?v=HVsySz-h9r4 Git Tutorial for Beginners: Command-Line Fundamentals], vidéo de Corey Schafer.
 +
* [https://www.youtube.com/watch?v=uR6G2v_WsRA Introduction to Git - Core Concepts], vidéo de David Mahler.
  
 +
[[Category:Developer Documentation{{#translation:}}]]
 
{{clear}}
 
{{clear}}
<languages/>
 

Latest revision as of 16:39, 20 March 2021

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski

Introduction

Le principal outil de gestion de code source du projet FreeCAD est Git, qui peut être facilement installé dans la plupart des systèmes d'exploitation à partir d'un gestionnaire de paquets ou directement à partir de Git's website. Nous vous conseillons de vous familiariser avec Git avant de travailler directement avec le code source FreeCAD. Visitez la page Git documentation pour obtenir le manuel de référence, ainsi que le Pro Git book pour apprendre à utiliser le système de manière générale. Le présent document porte sur l'utilisation de Git pour le développement FreeCAD. La compilation de FreeCAD est décrite dans Compilation.

Bien que Git soit principalement une application de terminal, il existe de nombreux clients graphiques qui facilitent le travail avec les branches, l’application de correctifs et la soumission de demandes d'extraction à une branche principale. Les exemples incluent gitk (la première interface graphique développée), gitg (Gnome), qgit (Qt), tig (Ncurses), git-cola et GitKraken (propriétaire). Veuillez consulter Developing FreeCAD with GitKraken pour une introduction sommaire à cet outil.

Remarque: si tout cela commence à vous donner le vertige, il existe une très bonne série non technique sur l'utilisation de git et Github appelée 'Git et Github pour les poètes'

Accès au code source

Tout le monde peut accéder et obtenir une copie du code source de FreeCAD, mais seuls les gestionnaires de projet(s) peuvent en modifier le contenu. Vous pouvez avoir une copie du code, l'étudier et le modifier comme vous le souhaitez, mais si vous voulez que vos modifications soient prises en compte dans le code source officiel, vous devez effectuer un "pull request" sur le dépôt master. Les gestionnaires pourront alors vérifier vos modifications avant de les valider. Cette façon de développer est connue sous le nom de flux de travail des dictateurs et des lieutenants où les développeurs principaux (dictateurs) et développeurs de confiance (lieutenants) filtrent le code soumis par les développeurs et les utilisateurs indépendants.

Si votre code source change de manière significative, il vous est conseillé de l'expliquer dans la section "pull requests" du forum FreeCAD.

FreeCAD git workflow.svg

Flux de travail générique pour développer du code pour FreeCAD; Tout le monde peut récupérer le code depuis le dépôt principal, mais les développeurs principaux ont les droits exclusifs pour faire une revue et prendre en compte les changements apportés par les autres développeurs.

Dépôt officiel Github

Le code source de FreeCAD est hébergé sur https://github.com/FreeCAD/FreeCAD

Pour pouvoir contribuer et accéder au code source, vous devez avoir un compte GitHub.

Dans le passé, le code source était hébergé en tant que dépôt SVN, https://free-cad.svn.sourceforge.net/svnroot/free-cad. Cela a été déplacé vers GitHub le 10 octobre 2011, avec commit 120ca87015.

Par conséquent, de nombreuses modifications ont été apportées avant cette date qui ne sont pas enregistrées dans l'historique de validation Git moderne. Pour en savoir plus, consultez la page Histoire.

Configuration de votre nom d'utilisateur Git

Les développeurs doivent faire un commit vers leur dépôt de leur code, en utilisant leur nom personnel d'utilisateur GitHub. Si ce n'est pas déjà fait globalement, vous pouvez le régler au niveau local pour le dépôt Git actuel comme ceci :

git config user.name "YOUR_NAME"
git config user.email GITHUB_USERNAME@users.noreply.github.com

"YOUR_NAME" représente votre nom complet ou votre pseudonyme, utilisé pour identifier l'auteur d'un commit spécifique, et GITHUB_USERNAME indique le nom de votre compte sur GitHub.

Note sur les dépôts distants

Veuillez lire what-is-the-difference-between-origin-and-upstream-on-github#9257901 Quelle est la différence entre l'origine et l'upstream sur GitHub? (Stackoverflow) pour vous aider à comprendre la différence entre origin et upstream dans Git. Cette section explique comment définir les référentiels appropriés pour le développement. Essentiellement:

La distinction est importante, vous devez d'abord écrire votre code dans votre propre dépôt, avant de "pousser" ces changements sur le dépôt officiel.

Sur la base de ce qui précède, il existe deux manières de configurer votre environnement de développement Git:

  • 1ère méthode: fork GitHub et clonez votre fork localement
  • 2ème méthode: clonez FreeCAD directement sur votre machine locale et ajustez les serveurs distants

Nous recommandons la première méthode car c'est la plus rapide.

1ère méthode: Créez une branche sur GitHub et clonez votre branche localement

Vous allez d'abord créer le référentiel FreeCAD dans GitHub, puis cloner ce fork personnel sur votre ordinateur et enfin définir le référentiel upstream.

  • Log in sur votre compte GitHub.
  • Accédez au référentiel officiel FreeCAD: https://github.com/FreeCAD/FreeCAD
  • En haut à droite de la page, appuyez sur le bouton "Fourchette". Cela créera une copie personnelle du référentiel FreeCAD sous votre nom d'utilisateur GitHub: https://github.com/GITHUB_USERNAME/FreeCAD
  • Sur votre machine, clonez votre nouvelle fourche FreeCAD. Il sera créé dans un répertoire freecad-source.
git clone https://github.com/GITHUB_USERNAME/FreeCAD.git freecad-source
  • Une fois le téléchargement terminé, entrez le nouveau répertoire source et définissez le référentiel upstream.
cd  freecad-source
git remote add upstream https://github.com/FreeCAD/FreeCAD.git
  • Confirmez vos référentiels distants avec git remote -v; la sortie devrait être semblable à celle-ci
origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (push)
upstream	https://github.com/FreeCAD/FreeCAD.git (fetch)
upstream	https://github.com/FreeCAD/FreeCAD.git (push)
  • Maintenant, le développement peut commencer.

2ème méthode: clonez le dépôt officiel FreeCAD git sur votre ordinateur local

Vous allez d'abord créer le référentiel FreeCAD dans GitHub, mais vous clonerez le référentiel FreeCAD d'origine sur votre ordinateur local, puis modifierez vos télécommandes via le terminal.

  • Log in sur votre compte GitHub.
  • Accédez au référentiel officiel FreeCAD: https://github.com/FreeCAD/FreeCAD
  • En haut à droite de la page, appuyez sur le bouton "Fourchette". Cela créera une copie personnelle du référentiel FreeCAD sous votre nom d'utilisateur GitHub: https://github.com/GITHUB_USERNAME/FreeCAD
  • Clonez le référentiel FreeCAD d'origine. Il sera créé dans un répertoire freecad-source.
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
  • Une fois le téléchargement terminé, entrez le nouveau répertoire source et définissez le référentiel origin.
cd freecad-source
git remote add origin https://github.com/GITHUB_USERNAME/FreeCAD.git
  • Ensuite, configurez le référentiel upstream.
git remote add upstream https://github.com/FreeCAD/FreeCAD.git
  • Confirmez vos référentiels distants avec git remote -v; la sortie devrait être semblable à celle-ci
origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch)
origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (push)
upstream	https://github.com/FreeCAD/FreeCAD.git (fetch)
upstream	https://github.com/FreeCAD/FreeCAD.git (push)
  • Maintenant, le développement peut commencer.

Si, pour une raison quelconque, les référentiels distants existent mais indiquent une adresse incorrecte, vous pouvez remédier à la situation en renommant le nom du référentiel distant. Par exemple, origin doit pointer sur votre branche personnelle; s'il pointe vers le référentiel FreeCAD d'origine, remplacez le nom de cette télécommande par upstream et ajoutez manuellement le référentiel origin.

git remote rename origin upstream
git remote add origin https://github.com/GITHUB_USERNAME/FreeCAD.git
git remote -v

Vous pouvez également afficher plus d'informations avec le mot clé show.

git remote show origin
git remote show upstream

Processus de développement Git

Ne développez jamais sur votre branche master locale. Au lieu de cela, créez une branche locale pour le développement, puis fusionnez cette branche locale avec la branche principale en amont via une demande d'extraction. Veuillez lire Git Branching, Fusioning, et GitHub - Contribuer à un projet pour en savoir plus


FreeCAD git branches workflow.svg

Flux de travail générique pour développer du code pour FreeCAD en utilisant git; Un "fork" du dépôt principal est créé sur le serveur distant et cloné sur un ordinateur local (0); De nouvelles branches (1) sont utilisées pour appliquer des modifications et des ajouts de code localement (2); Les branches sont "rechargées" avec la version de code la plus récente du serveur (3), et elles sont ensuite "poussées" vers le dépôt distant (4); Puis un "Pull Request" est créé afin de pouvoir fusionner le code dans le dépôt principal (5). Le clone du "fork" sur l'ordinateur local est alors mis à jour avec le nouveau code master du serveur (a); ce master mis à jour est également "poussé" vers le dépôt distant (b) afin d'obtenir le même code à la fois sur le serveur distant et l'ordinateur local.

Ramifications

Au lieu de travailler sur la version principale du code, les meilleures pratiques avec Git recommandent de créer une nouvelle branche chaque fois que vous souhaitez travailler sur une nouvelle fonctionnalité. Les branches sont peu coûteuses en ressources, elles ne copient pas l’ensemble de l’arborescence des sources, mais créent simplement un point dans le temps sur lequel vous allez écrire du code; ainsi, les branches aident à garder le travail en cours séparé du code principal.

L'ajout d'une nouvelle branche est réalisée en 2 étapes : Tout d'abord vous créez la branche, puis vous vous commutez sur celle-ci.

git branch myNewBranch
git checkout myNewBranch

Sinon, effectuez les deux étapes avec une seule instruction:

git checkout -b myNewBranch

Maintenant, vous pouvez changer de branche avec checkout chaque fois que vous avez besoin de travailler dessus. Pour afficher les branches de votre projet et de la branche actuelle, utilisez l'opération branch seule ou ajoutez -v ou -vv pour plus d'informations:

git branch
git branch -vv

Une fois que vous avez effectué les changements et que vous les avez validés (commit), utilisez la ligne de commande log avec les options suivantes pour visualiser les branches.

git log --oneline --decorate --graph --all

Validation des modifications

Une fois que vous êtes dans une nouvelle branche, éditez les fichiers sources que vous voulez avec votre éditeur de texte. Pour voir quels fichiers ont été modifiés, utilisez la commande status et diff; Lorsque que vous êtes satisfait de votre travail, validez le avec la commande commit :

git status
git diff
git commit -a

Contrairement à SVN, vous devez indiquer précisément les fichiers à valider. utilisez l'option -a pour enregistrer les modifications dans tous les fichiers modifiés. Votre éditeur de texte, par exemple, nano ou vim, s'ouvrira pour vous permettre d'écrire un message de validation.

Alternativement, ajoutez le message dans le "commit" lui-même:

git commit -a -m "Fix the bug in the clone function."

Si vous créez de nouveaux fichiers ou répertoires, vous devez d'abord utiliser l'opération add pour les ajouter au référentiel local avant de valider les modifications.

git add path
git commit -a

path peut être n'importe quel répertoire ou fichier.

Rédaction de bons messages de commit

Vous devriez essayer de travailler en petites sections. Si vous ne pouvez pas résumer vos modifications en une seule phrase, il y a probablement trop longtemps, que vous avez fait un commit.

Pour les grands changements, il est important que vous disposiez de descriptions utiles et utiles de votre travail. FreeCAD a adopté un format mentionné dans le livre Pro Git, qui consiste en un court message, puis en un paragraphe descriptif plus grand.

Court sommaire des changements (50 caractères ou plus)

 Si nécessaire, bien détailler les textes explicatifs. Ecrivez-en environ 72 caractères ou plus.
 Dans certains cas, la première ligne est considérée comme l'objet (résumé) d'un email, et, le reste du texte comme le corps.
 Laisser une ligne blanche pour séparer le résumé, du corps du message (sauf si vous omettez lentièreté corps);
 des outils comme '''rebase''' peut se confondre si vous exécutez les deux ensemble.

 Les paragraphes supplémentaires, viennent après les lignes vides.

 - Les puces sont très bien aussi

 - En général, un trait d'union ou un astérisque est utilisé pour la puce, précédé d'un
   espace unique, avec des lignes blanches entre les deux, mais ici les conventions varient.

Si vous effectuez de nombreux travaux connexes dans une branche, vous devez effectuer de nombreux petits commits (voir un forum post) . Lorsque vous souhaitez fusionner ces modifications dans la branche principale, vous devez émettre

git log master..myNewBranch

pour voir les messages individuels de commit. Vous pouvez ensuite écrire un message de haute qualité lors d’une fusion.

Lorsque vous fusionnez pour maîtriser, utilisez l'option --squash et validez avec votre message de validation de qualité. Cela vous permettra d'être très libéral avec vos commits et vous aidera à fournir un bon niveau de détail dans les messages de validation sans autant de descriptions distinctes.

Regroupement des "commits"

Il est possible de regrouper plusieurs "commits" consécutifs dans 1 seul "commit", on appelle ça le "squashing". Ceci peut être utile dans les cas où vous avez effectué beaucoup de "petits commits" et que vous souhaitez les regrouper dans un seul "commit". Par exemple, lorsque vous changez simplement une variable, que vous corrigez des erreurs d'orthographe ou que vous ajustez la mise en forme de votre code. Vous devez faire des regroupements uniquement sur des "petits commits". Les grandes modifications effectuées sur plusieurs fichiers doivent contenir l'ensemble de l'historique des changements du commit.

Avec la commande git log --oneline, vous pouvez voir plusieurs "commits" consécutifs dont le plus récent est situé en haut de la liste. Dans cet exemple, plusieurs "commits" ont été effectués à partir de la "fonctionnalité A" pour réaliser l'implémentation de la "fonctionnalité B"; Nous souhaiterions maintenant regrouper tous les "commits" effectués pour la "fonctionnalité B" en un seul.

871adb OK, feature B is fully implemented
1c3317 Whoops, it is not ready yet...
87871a I'm almost ready!
643d0e Code cleanup
af2581 Fix this and that
4e9baa Good implementation
d94e78 Prepare the module for feature B
6394da Feature A

Utilisez la commande rebase avec l'option --interactive ou -i pour sélectionner différents "commits" et les regrouper en un seul. Utilisez la valeur de hachage située juste devant le premier commit que vous voulez regrouper. Dans notre cas, il s'agit de celui qui correspond à la "fonctionnalité A".

git rebase -i 6394da

un éditeur de ligne de commande comme nano ou vim s'ouvrira pour vous montrer les "commits", mais cette fois avec le plus ancien en haut de la liste. Avant chaque "commit", le mot pick sera affiché. Supprimez le mot pick, et écrivez le mot squash ou juste la lettre s à la place, à l'exception de la première entrée; Ce "commit" est le plus ancien, donc tous les futurs "commits" seront regroupés dans celui-ci.

pick d94e78 Prepare the module for feature B
s 4e9baa Good implementation
s af2581 Fix this and that
s 643d0e Code cleanup
s 87871a I'm almost ready!
s 1c3317 Whoops, it is not ready yet...
s 871adb OK, feature B is fully implemented

Sauvegardez le fichier et fermez l'éditeur.

L'éditeur s'ouvrira de nouveau. Vous pouvez maintenant ajouter un long message qui décrira tous les changements effectués comme s'ils étaient réunis dans un seul "commit". Sauvegardez le fichier et fermez l'éditeur une fois de plus. Ceci finira l'action de regroupement de ces "commits" avec le nouveau message que vous avez saisis.

Vous pouvez encore utiliser git log --oneline pour observer le nouvel historique des changements du commit. Dans ce cas, seul un simple "commit" pour la "fonctionnalité B", apparaitra au dessus du "commit" non modifié pour la "fonctionnalité A".

c83d67 OK, feature B is fully implemented now, with proper module setup, and clean code.
6394da Feature A

Publication de votre travail sur votre dépôt GitHub

Les branches locales de votre ordinateur ne sont pas automatiquement synchronisées avec les serveurs distants que vous avez spécifiés comme origine ou en amont (voir Référentiels distants); vous devez explicitement pousser les branches sur les serveurs distants, pour lesquels vous devez avoir un accès en écriture. Une fois que cela est fait, les branches deviennent publiques et disponibles pour être revues par d'autres développeurs.

Pour FreeCAD, vous devez placer votre branche locale dans le référentiel distant origin, à savoir, https://github.com/GITHUB_USERNAME/FreeCAD. Vous devez entrer votre nom d'utilisateur et votre mot de passe chaque fois que vous appuyez, sauf si vous avez configuré mise en cache. Veuillez lire Pushing dans un référentiel distant pour plus d'informations.

git push origin myNewBranch

Lorsque vous travaillez avec une seule branche, vous devrez peut-être rebaser, écraser et corriger les commits plusieurs fois de manière interactive. Dans ce cas, votre historique de branche ne sera pas simple et vous ne pourrez pas le pousser vers le référentiel distant. Vous pouvez obtenir un message comme le suivant, indiquant qu'il n'est pas possible d'effectuer un push "fast-forward" (avance rapide).

error: failed to push some refs to 'https://github.com/USER/FreeCAD.git'
hint: Updates were rejected because a pushed branch tip is behind its remote
hint: counterpart. Check out this branch and integrate the remote changes
hint: (e.g. 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

Pour pousser enfin votre branche vers le dépôt distant, vous devez la "forcer à la pousser". Cela remplacera complètement votre branche distante par la branche réelle que vous avez hors ligne.

git push -f origin myNewBranch

Le développeur standard n'a pas d'accès en écriture au référentiel upstream https://github.com/FreeCAD/FreeCAD. Par conséquent, vous ne devez jamais envoyer de code à ce serveur distant.

Rebasing de l'amont

Pendant que vous travaillez sur votre propre branche, le code officiel de FreeCAD continue de s'améliorer avec les "commits" des autres développeurs, ce qui créé une différence de contenu avec votre branche personnelle.

      .-----A origin/myNewBranch
     / 
-----o-----------Z FreeCAD upstream/master

Par conséquent, lorsque vous êtes prêt à fusionner votre branche sur le dépôt principal de FreeCAD, vous devez faire un "rebase" (sorte de re-synchronisation) de votre copie du dépôt, afin que son contenu se rapproche le plus possible de celui du dépôt officiel. Voir le document Git Branching - Rebasing pour plus d'informations.

git checkout myNewBranch
git pull --rebase upstream master

Cette opération va télécharger le code à partir de la branche master du dépôt upstream (le code source officiel de FreeCAD), et va le fusionner avec celui de votre branche courante (myNewBranch), afin que vos modifications apparaissent tout en haut de la liste du dernier code officiel. Si personne n'a réalisé de modifications dans les fichiers sur lesquels vous avez travaillés, la fusion se fera sans erreurs. Si certains fichiers ont été modifiés en même temps par des personnes différentes, il se peut qu'il y ait des conflits qui devront être résolus.

                  .-----A' origin/myNewBranch
                 /
-----o-----------Z FreeCAD upstream/master

Pour résumer, vous devez être dans la branche appropriée, faire un "rebase" et puis un "push".

git checkout myNewBranch
git pull --rebase upstream master
git push origin myNewBranch

L'opération pull est équivalente à un fetch (récupération) suivit d'un merge (fusion). Lorsque l'option --rebase est utilisée, à la place de faire un simple merge, c'est l'opération rebase qui sera exécutée.

git pull upstream

git fetch upstream
git merge FETCH_HEAD
git pull --rebase upstream master

git fetch upstream
git rebase master

Fusion de la branche (pull request)

Une fois que vous avez validé vos modifications, "mis à jour" votre branche à partir du dépôt principal et "poussé" votre branche sur le serveur, vous pouvez initier un "pull request". Un "pull request" informe les administrateurs du dépôt officiel de FreeCAD que vous souhaitez fusionner le nouveau code de votre branche avec le code officiel.

Dès que vous transmettez le code à votre référentiel origin https://github.com/GITHUB_USERNAME/FreeCAD, GitHub vous offre la possibilité de comparer et de créer une demande d'extraction par rapport au Référentiel upstream. En appuyant sur le bouton Compare & pull request, vous ouvrirez une interface qui vous permettra de choisir quel référentiel est la "base", cible de la fusion, et quelle est la "tête", de votre code supplémentaire. Une vérification rapide sera effectuée par le système vous indiquant s'il n'y a pas de conflit avec les fichiers que vous avez modifiés; si vous avez travaillé sur des fichiers que personne n'a touchés, votre branche pourra fusionner proprement. De plus, il vous montrera un éditeur de texte afin que vous puissiez écrire un message documentant vos modifications. il affichera également le nombre de commits dans votre branche, le nombre de fichiers modifiés et une vue indiquant les différences entre la "base" et la "tête", afin que tout le monde puisse voir immédiatement les modifications que vous souhaitez apporter.

base repository: FreeCAD/FreeCAD    base: master  <----  head repository: GITHUB_USERNAME/FreeCAD    compare: myNewBranch

Able to merge. These branches can be automatically merged.

Cliquez sur Create pull request pour continuer. Un message apparaîtra indiquant que certaines vérifications doivent être effectuées sur le code. C'est un système qui compile automatiquement FreeCAD et exécute les tests unitaires. Si les tests réussissent, la demande d'extraction aura plus de chance d'être fusionnée dans le code principal, sinon un rapport sera généré indiquant les erreurs rencontrées. Voir FreeCAD.

Some checks haven’t completed yet

* continuous-integration/travis-ci/pr Pending — The Travis CI build is in progress  |Required|

Si les tests réussissent, vous verrez un message tel que le suivant

Tous les tests ont passés

* continuous-integration/travis-ci/pr — The Travis CI build passed  |Required|

Cette branche n'a pas de conflits avec la branche de base Seules les personnes ayant un accès en écriture à ce référentiel peuvent fusionner des demandes d'extraction.

Vous devez maintenant attendre que les administrateurs fusionnent votre branche. vous serez averti lorsque cela se produira.

Pull request successfully merged and closed

Youre all set  the GITHUB_USERNAME:myNewBranch branch can be safely deleted.
If you wish, you can also delete your fork of FreeCAD/FreeCAD.

Si vous le souhaitez, vous pouvez supprimer la branche qui vient d'être fusionnée, ou même votre branche entière de FreeCAD, car votre propre code est déjà inclus à la fin de la branche principale.

-----o-----------Z----A' FreeCAD upstream/master

Note: vous pouvez continuer à travailler (git commit -a) sur la même branche en attendant l'approbation de la fusion; si vous git push à nouveau, une deuxième validation de fusion sera mise en file d'attente dans la même demande d'extraction, et un autre test automatisé sera effectué. En d’autres termes, même si vos administrateurs n’approuvent pas encore vos fusions, vous pouvez continuer à appliquer des modifications à votre référentiel origin, ce qui mettra ces commits en file d'attente dans la même demande d'extraction du référentiel en amont. L'utilisation d'une seule demande d'extraction pour mettre en file d'attente plusieurs commits individuels est souvent souhaitable pour de petites modifications. Pour les ajouts importants au code source, vous devez créer une autre branche, d'y développer vos fonctionnalités, puis soumettre une demande d'extraction distincte pour cette branche.

L'interface de requête d'extraction peut être utilisée chaque fois que vous souhaitez soumettre du code à partir de vos propres référentiels vers un autre référentiel de GitHub. Vous pouvez également l'utiliser pour fusionner du code dans la direction opposée, des branches d'autres personnes à la vôtre, ou même entre vos propres branches. Dans le dernier cas, puisque vous possédez les branches, les fusions peuvent être approuvées par vous-même immédiatement.

base repository: SomeProject/Some_Software  base: master       <----  head repository: GITHUB_USERNAME/Some_Software  compare: add_new_functions
base repository: GITHUB_USERNAME/FreeCAD    base: myNewBranch  <----  head repository: FreeCAD/FreeCAD                compare: master
base repository: GITHUB_USERNAME/FreeCAD    base: myNewBranch  <----  head repository: GITHUB_USERNAME/FreeCAD        compare: fix-many-bugs-branch

Maintien du dépôt GitHub à jour

Une fois que vous avez créé FreeCAD, votre référentiel personnel existe indépendamment de l'original. Lorsque le référentiel d'origine comporte de nouveaux commits, GitHub vous informera que votre référentiel personnel est en retard sur le nombre de commits:

This branch is 5 commits behind FreeCAD:master.

De la même manière, si vous avez créé une branche de développement avec un nouveau code, GitHub vous informera que cette branche est en avance en nombre de validations; c'est-à-dire que cette branche contient des modifications qui n'ont pas été fusionnées dans le référentiel officiel de FreeCAD:

This branch is 3 commits ahead of FreeCAD:master.

Pendant le développement, les deux cas sont possibles, car votre propre branche peut ne pas avoir de commits faits par d’autres développeurs, mais inclure de nouveaux commits de votre part:

This branch is 2 commits ahead, 14 commits behind FreeCAD:master.

Lors du développement du code, il est recommandé de rebaser la branche dans laquelle vous travaillez actuellement, car cela mettra votre branche toujours devant le code maître FreeCAD.

Quant à votre branche originale master, elle ne sera jamais automatiquement mise à jour par GitHub; c'est quelque chose que vous devez faire vous-même. Passez à la branche master, puis à pull à partir de amont qui effectue un fetch et fusion, puis poussez cette branche master mise à jour vers votre référentiel origine distant.

git checkout master
git pull upstream master
git push origin master

Une fois cela fait, GitHub vous indiquera que vous êtes synchronisé avec le référentiel upstream.

This branch is even with FreeCAD:master.

Maintenant que votre master est à jour, vous pouvez décider de le changer et de supprimer l’autre branche que vous avez utilisée précédemment pour développer une fonctionnalité.

git checkout master
git branch -d myNewBranch

Pour supprimer la branche du référentiel distant origin, vous pouvez utiliser l'opération push. Normalement, vous poussez une branche locale; cela crée une branche distante portant le même nom que votre branche locale.

git push origin myNewBranch

Toutefois, si vous utilisez la notation local_name:remote_name, la branche locale est créée dans le référentiel distant sous un nom différent:

git push origin myNewBranch:someRemoteBranch

Par conséquent, vous pouvez supprimer la branche distante en poussant une branche locale vide:

git push origin :myNewBranch
git push origin :someRemoteBranch

Maintenant que vous ne disposez que d'un master à jour, vous pouvez créer une nouvelle branche et répéter les étapes de modification de fichiers, de validation, d'insertion, de soumission d'une demande d'extraction, de fusion et de mise à jour.

git checkout master
git checkout -b anotherBranch

Si vous ne souhaitez pas supprimer votre branche déjà personnalisée, vous pouvez forcer la mise à jour pour correspondre à la valeur de la mise à jour master; vous pouvez ensuite faire ce que vous voulez, y compris ajouter plus de commits et le pousser dans le référentiel distant origin.

git checkout myNewBranch
git reset --hard master
git push -f origin myNewBranch

Réinitialiser une branche comme ceci n’est généralement pas nécessaire. Dans la plupart des cas, vous souhaitez suivre la séquence de création d'une nouvelle branche, de validation des modifications, de transmission de ces modifications, de fusion de la branche, puis de suppression de la branche.

Opérations git avancées

Rechercher

Quelques outils pratiques pour vous aider à trouver ce que vous cherchez:

Rechercher les noms de fichiers

Utilisez git ls-files pour rechercher dans le dépôt un fichier contenant une certaine chaîne dans un nom de fichier. L'exemple ci-dessous renverra toutes les instances des fichiers contenant 'dxf' dans leurs noms de fichiers.

git ls-files *dxf*


Rechercher une chaîne

Utilisez git grep pour rechercher dans le dépôt un fichier contenant une certaine chaîne avec les fichiers eux-mêmes. L'exemple ci-dessous renverra toutes les instances des fichiers qui contiennent 'dxf' dans chaque fichier.

git grep dxf


Résolution des conflits de fusion

La fusion de branches avec git merge ou la redistribution de votre branche avec git rebase présente parfois des conflits de fichiers pouvant avoir été modifiés par un autre auteur en même temps. Si cela se produit, vous devriez voir les modifications des deux côtés, de l'autre auteur et du vôtre, puis décider de la meilleure façon d'inclure les deux ensembles de modifications. Ceci est normalement un processus manuel qui ne peut pas être automatisé; le programmeur doit comprendre le code et décider du code à déplacer, réécrire ou abandonner pour résoudre le conflit.

Lorsqu'un conflit survient, un message comme celui-ci peut apparaître.

CONFLICT (content): Merge conflict in src/Mod/source_code.py
error: Failed to merge in the changes.
Patch failed at 1234 Some commit message when editing source_code.py

Si un outil de différenciation spécialisé est installé et configuré pour Git, par exemple, celui de Gnome Meld, le conflit peut être examiné et résolu en utilisant l'opération mergetool..

git mergetool

L'outil de fusion affiche normalement trois colonnes; les deux colonnes sur les côtés affichent les deux fichiers en conflit, tandis que la colonne du milieu affiche le nouveau code qui sera enregistré et finalement validé. Par conséquent, cette colonne centrale doit être modifiée de manière à intégrer le code des deux colonnes latérales. Une fois le conflit résolu et le nouveau code source (la colonne centrale) enregistré, vous pouvez fermer l’outil de fusion. Ensuite, l'opération merge ou rebase peut continuer.

git merge --continue
git rebase --continue

Pour plus d'informations sur la fusion et la résolution des conflits, voir:

Inspecter les changements

Inspectez l'historique des modifications apportées à un fichier qui a subit plusieurs "commits" avec l'opération log:

git log --patch path

path peut être n'importe quel répertoire ou fichier. Au lieu de --patch, vous pouvez également utiliser les raccourcis -p ou -u.

Inspecter les changements entre deux branches

Inspectez les modifications entre deux branches avec les opérations log et diff avec les noms des branches:

git log master..myBranch
git diff master..myBranch

L'opération log affiche les validations, tandis que diff indique les modifications réelles apportées aux fichiers.

Réinitialiser les fichiers et les répertoires

Si vous avez accidentellement apporté des modifications à un fichier ou à un répertoire, vous souhaiterez peut-être annuler complètement ces modifications pour obtenir l'état précédent du code source.

Cela peut être fait rapidement en utilisant l'opération checkout:

git checkout path
git checkout .

Cela restaurera le path (un fichier ou un répertoire) à l'état dans lequel il se trouve à l'extrémité de la branche, en ignorant les modifications qui n'ont pas été validées. Si path est le point unique ., Tous les fichiers du répertoire en cours seront restaurés.

Si vous avez accidentellement ajouté des fichiers et des répertoires, vous pouvez utiliser l'opération clean:

git clean -df

Ceci forcera la suppression de tous les fichiers et répertoires (-df) qui ne font pas l'objet d'un suivi par le référentiel, c'est-à-dire ceux qui n'ont pas été inclus précédemment avec l'opération add.

Pour réinitialiser complètement le référentiel en perdant toutes les modifications non validées, utilisez l'opération reset:

git fetch
git reset --hard FETCH_HEAD

FETCH_HEAD est la pointe du référentiel upstream. Un autre commit peut également être utilisé.

L'opération revert annule également les modifications. Cependant, cette commande fait cela en ajoutant un autre commit à l'historique; dans de nombreux cas, cela n'est pas souhaité.

Taille des vieilles branches

Si vous avez engagé de nombreuses branches dans le référentiel upstream, vous souhaiterez peut-être supprimer ces branches de votre système local car elles ont déjà été fusionnées. La branche en ligne du référentiel origin peut être supprimée immédiatement après la fusion. Ensuite, vous pouvez supprimer les références locales à cette branche en utilisant les options --prune ou prune pour les opérations fetch et remote.

git fetch --prune origin
git remote prune origin

Enfin, vous pouvez supprimer les branches localement

git branch -D myBranch

Après un certain temps, il est également recommandé de procéder à la récupération d'espace disque, en utilisant l'opération gc. Cela supprimera les fichiers inutiles et compressera les révisions de fichiers locaux, afin d'optimiser l'utilisation du disque local du référentiel.

git gc

Travailler avec des patchs

Bien que Git vous permette de fusionner le code de différentes branches localement sur votre ordinateur via la commande git merge ou d'effectuer un "pull request" sur le serveur distant (remote repository), il est parfois préférable de créer un patch qui peut être envoyé en tant que pièce jointe par e-mail au lieu de soumettre un PR. Le flux de travail suivant explique comment procéder:

Création de correctifs

  • Il est conseillé de travailler dans une nouvelle branche et non pas directement sur la branche master de votre dépôt. La première étape consiste donc à s'assurer que vous êtes dans la bonne branche et le cas échéant à s'y raccorder. Les commandes suivantes permettent de réaliser ces opérations :
git branch -v
git checkout myBranch
  • Maintenant, utilisez la commande git format-patch et l'option --stdout pour envoyer le résultat vers la sortie standard STDOUT (Ecran); le résultat sera ensuite redirigé vers un fichier qui par commodité sera créé dans un dossier de niveau supérieur à celui du code source.
git format-patch master --stdout > ../myCode.patch
  • Une autre méthode
git format-patch HEAD^
git format-patch HEAD~1

Le nombre d'accents circonflexes ^ ou le nombre situé derrière le tilde ~ 1 indique le nombre de "commits" qui devront être considérés, à savoir par exemple ^^^ ou ~3 va créer 3 correctifs pour 3 "commits".

git format-patch HEAD^

Cette commande va créer un "patch" ou une série de "patchs" en respectant la convention de nommage suivante :

XXXX-commit-message.patch

XXXX est un nombre compris entre 0000 et 9999, et où le message du "commit" forme la majorité du nom du fichier, par exemple :

0001-fix-ViewProjMatrix-getProjectionMatrix.patch

Application des correctifs

Git a la capacité de fusionner des correctifs/diffs. Pour en savoir plus à ce sujet, lisez la référence suivante: Application des patches avec Git

Si vous avez déjà le fichier du correctif dans votre système, il suffit juste de l'appliquer.

git apply myCode.patch

Vous pouvez utiliser curl pour télécharger un correctif depuis un site web, et ensuite l'appliquer via la commande git.

curl -O https://some.website.org/code/myCode.patch
git apply myCode.patch

Conseil utile: ajoutez simplement .diff ou .patch à la fin de l'URL d'une page de validation GitHub, d'une demande d'extraction ou d'une vue de comparaison et vous obtiendrez une vue de cette page. Exemple:

Vous pouvez pointer curl vers le "commit" d'un correctif particulier dans un dépôt, et le faire suivre directement vers git pour appliquer le correctif.

curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -

Inverser un patch

Lorsque vous appliquez un correctif, vous modifiez certains fichiers. Cependant, ces modifications ne sont pas permanentes tant que vous n'avez pas validé les modifications. Par conséquent, si vous souhaitez rétablir un correctif, utilisez les instructions suivantes.

Cette commande annulera les modifications qui ont été appliquées, si vous avez toujours accès au fichier original du correctif:

git apply -R myCode.patch

Cette commande alternative enlèvera toutes les modifications non validées dans la branche.

git checkout -f

Stockage temporaire dans le cache des git commits

Supposons que vous travaillez sur une branche et que vous apportiez des modifications à la source qui sortent du cadre de votre branche actuelle; autrement dit, ces changements seraient meilleurs dans une autre branche que dans la branche actuelle. La commande git stash peut être utilisée pour stocker temporairement ces modifications locales non validées.

git stash

Si à l'avenir vous souhaitez utiliser ces commits, vous pouvez les extraire de la réserve puis dans votre branche active.

git stash pop

Ou si vous décidez que vous n'aimez plus ces commits sauvegardés, vous pouvez les supprimer complètement de la réserve.

git stash drop

Vous pouvez lister plusieurs commits stash avec

git stash list

Pour en savoir plus, lisez Useful tricks you might not know about Git stash.

Vérifier sur GitHub les demandes locales

Checkout GitHub pull requests locally


Blâme

Section TBD


Ajouter du contenu depuis https://forum.freecadweb.org/viewtopic.php?f=23&t=55943&p=481483#p481287

Numéro de révision FreeCAD

Contrairement à Subversion qui incrémente le numéro de révision, Git génère une valeur de hachage SHA-1 à chaque "commit". Une valeur de hachage est une longue chaîne de caractères alphanumériques qui ressemble à ceci :

9b3ffef570596e184006287434fba54a4b03ccc3

Quelle est la dernière révision de FreeCAD Dev ?

Pour trouver le dernier numéro de révision d'une branche particulière, utilisez l'opération rev-list avec l'option --count. Donnez le nom de la branche, du référentiel distant, de la balise ou un pointeur spécial tel que HEAD, pour indiquer le dernier commit dans cet objet particulier.

git rev-list --count master
git rev-list --count HEAD
git rev-list --count origin

ou parcourez le dépôt sur GitHub et lisez le nombre de mises à jour (commits) effectuées dans la branche correspondante.

Quel est le numéro de révision correspondant à la valeur de hachage d'un "commit" ?

Comme la valeur de hachage est une chaîne de caractères alphanumériques, il n'est pas très utile de savoir si un "commit" est plus ancien ou plus récent qu'un autre. Pour trouver le numéro de révision correspond à une valeur de hachage particulière, utilisez à nouveau l'opération rev-list; l'entrée peut être la valeur de hachage complète ou une valeur de hachage partielle qui est unique, généralement les 7 premiers chiffres sont suffisants.

git rev-list --count ab1520b872821414c6ce4a15fb85d471ac2a2b03
git rev-list --count 9948ee4

Quel est la valeur de hachage correspondante au numéro de révision d'un "commit" ?

Si nous avons un "commit" qui porte le numéro 15000 et que nous voulons trouver la valeur de hachage correspondante, nous allons avoir besoin de calculer le nombre de "commits" réalisés entre ce "commit" et le dernier "commit" (HEAD). Dans un premier temps, cherchons le numéro du dernier "commit".

git rev-list --count HEAD
17465

Puis, soustrayons à ce résultat le "commit" que nous voulons.

17465 - 15000 = 2465

Puis, utilisez la commande log pour afficher la liste des "commits" et des valeurs de hachage. L'option --skip permet de sauter la différence dans les "commits" que nous avons calculez, ce qui nous permet d'aller directement à la valeur de hachage que nous recherchons.

git log --skip=2465
commit 44c2f19e380e76b567d114a6360519d66f7a9e24

Il se peut que le résultat vous affiche 2 "commits" assez proches, confirmez que ce soit le bon numéro de "commit". Si ce n'est pas le cas, choisissez simplement le prochain "commit" dans la séquence (avant ou après) et vérifiez à nouveau.

git rev-list --count 44c2f19e38
15000

Comment le numéro de révision dans l'aide de FreeCAD est-il généré ?

Le numéro de version qui apparait avec l'outil Std About est définit dans le fichier src/Build/Version.h, qui est créé au moment de la compilation lorsque l'outil cmake est exécuté. Lisez le post Extract version number from git source pour plus d'informations.

Ajout d'autres référentiels (distants)

Plusieurs collaborateurs du projet FreeCAD ont leurs propres référentiels Git où ils développent leur travail où ils expérimentent de nouvelles idées avant d'être prêts à être inclus dans le code source officiel. Vous voudrez peut-être obtenir leurs sources afin de tester leur code vous-même lorsqu'ils font une demande d'extraction.

Utilisez la commande git remote pour ajouter ces autres référentiels afin que vous puissiez fetch (récupérer) et pull (pousser) suivre leurs codes.

git checkout master
git remote add OTHER_USER OTHER_URL
git fetch OTHER_USER
git checkout -b OTHER_BRANCH OTHER_USER/OTHER_BRANCH

Par exemple, ajoutons le dépôt de Bernd:

git remote add bernd http://github.com/berndhahnebach/FreeCAD_bhb

La commande git fetch télécharge les références à partir de ce dépôt distant.

git fetch bernd

Répertoriez toutes les branches de votre propre dépôt et celles de vous avez ajoutées. Les branches de Bernd s'afficheront sous la forme remotes/bernd/<branchname>.

git branch -a

Maintenant, regardons une liste résumée des 10 derniers commits de la branche femdev de Bernd.

git log -10 --oneline remotes/bernd/femdev

Maintenant, nous pouvons vérifier la branche à inspecter.

git checkout remotes/bernd/femdev

Ensuite, nous pouvons créer une branche locale basée sur la branche distante. Cette branche locale, nous pouvons la modifier et y ajouter notre propre code.

git checkout -b local_branch_name /remotes/bernd/femdev

Vous pouvez souhaiter git rebase la branche nouvellement obtenue sur la branche upstream/master pour vous assurer qu'elle utilise le dernier code. S'il y a des conflits, ils devront être résolus à ce stade.

git pull --rebase upstream master

La nouvelle branche est prête à être modifiée et compilée comme décrit dans Compiler.

Dirigez vous vers la section de développement du forum FreeCAD pour discuter du développement.

Lecture complémentaire