Source code management/fr

Notre principal outil de gestion de code est 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.

Il existe également de nombreux bons clients graphiques pour git, comme par exemple git-cola, qui rendent le processus de management des dépôts git plus facile. Il existe également une introduction superficielle au "Développement de FreeCad avec GitKraken"

Accès au code source
Tout le monde peut accéder et obtenir une copie du code source de FreeCAD, mais seulement les managers du projets ont les droits d'écriture. Vous pouvez obtenir une copie du code, l'étudier et le modifier autant que vous le souhaitez, mais si vous voulez faire des modifications que vous souhaitez voir incluses dans les sorties officielles, vous devez effectuer un "pull request" via la section "pull requests" du forum FreeCAD.

Dépôt officiel Github
Un façon simple de commencer à travailler avec le code source de FreeCAD est d'utiliser le dépot officle FreeCAD https://github.com/FreeCAD/FreeCAD

Configuration de votre nom d'utilisateur git
Les utilisateurs doivent faire un commit vers leur dépôt de projet, en utilisant leur nom 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" 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.

Note sur les dépôts distants
Veuillez lire quelques informations pour vous aider à mieux comprendre la différence entre ce que origin et upstream signifient dans le contexte de git. Cette section explique comment définir les dépôts Git distants en upstream et origin. En gros: Par conséquent, sur la base de ce qui précède, il existe 2 méthodes principales pour configurer votre environnement git: Nous recommandons la 1ère méthode pour la raison mentionnée ci-dessus.
 *   = votre fork du compte git FreeCAD alias https://github.com/GITHUB_USERNAME/FreeCAD.git
 *   = le dépôt git officiel FreeCAD alias https://github.com/FreeCAD/FreeCAD.git
 * Ceci est important à comprendre car si vous clonez  directement à partir de l', votre origine sera indiquée comme https://github.com/FreeCAD/FreeCAD.git. Si vous faites cela accidentellement, vous pouvez utiliser la commande   pour remédier à la situation.
 * 1ère méthode: forkez sur GitHub et clonez votre fork localement
 * 2ème méthode: clonez un officiel de FreeCAD directement sur votre machine locale

1ère méthode: forker sur GitHub et clonez votre fourchette localement
Cette méthode est recommandée car elle nécessite moins d’étapes. Vous allez pour l'essentiel forker le dépôt FreeCAD sur votre propre compte GitHub puis cloner localement le dit fork de GitHub. Ensuite vous définissez votre dépôt upstream dans git. La procédure est la suivante:  Vous inscrire pour un compte GitHub si vous n'en avez pas déjà un Allez sur le dépôt FreeCAD: https://github.com/FreeCAD/FreeCAD En haut à droite de la page, recherchez et appuyez sur le bouton "Fork" (il s'agira essentiellement de copier le dépôt officiel FreeCAD sur votre dépôt personnel GitHub: https://github.com/GITHUB_USERNAME/FreeCAD.git) Sur votre machine, clonez votre fork FreeCAD nouvellement créée en ouvrant un terminal et en tapant: git clone https://github.com/GITHUB_USERNAME/FreeCAD.git  Une fois le processus de clonage terminé, définissez maintenant votre   dépôt à distance (voir "Note sur les dépôts distants"). Trouvez où sont placés vos répertoires git distants. Taper   et ca devrait ressembler à: [foo@bar FreeCAD]$ git remote -v origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (fetch) origin	https://github.com/GITHUB_USERNAME/FreeCAD.git (push)  Maintenant, configurez votre   dépôt [foo@bar FreeCAD]$ git remote add upstream https://github.com/FreeCAD/FreeCAD.git  Vérifiez de nouveau et la aussi ca devrait ressembler à: [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)   Nous pouvons maintenant commencer à nous développer. Rendez vous sur "Processus de développement Git"</li> </ol>

2ème méthode: clonez le dépôt officiel FreeCAD git sur votre ordinateur local
Cette méthode de configuration de votre environnement git nécessite quelques étapes supplémentaires, puis la première méthode. Vous clonerez le dépôt FC git directement sur votre machine locale, puis modifierez vos dépôts distants via le terminal. La procédure est la suivante: <ol> Clonez le code FreeCAD avec git: git clone https://github.com/FreeCAD/FreeCAD.git </li> Créez un compte sur un serveur git public (GitHub, GitLab, etc ... pour nos besoins, nous supposons que c'est GitHub)</li> Repérez où sont placés vos répertoires git distants: git remote -v </li> Cela retournera quelque chose qui ressemble à ce qui suit: [foo@bar FreeCAD]$ git remote -v origin https://github.com/FreeCAD/FreeCAD.git (fetch) origin https://github.com/FreeCAD/FreeCAD.git (push) </li> Comme expliqué ci-dessus "Note sur les dépôts distants" vous devez modifier ces adresses de dépôt git distantes. Donc configurez votre   distant: [foo@bar FreeCAD]$ git remote add origin https://github.com/GITHUB_USERNAME/FreeCAD.git </li> Puis nous configurons notre   distant: [foo@bar FreeCAD]$ git remote add upstream https://github.com/FreeCAD/FreeCAD.git </li> Vérifiez de nouveau et la aussi ca devrait ressembler à: [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) </li> Nous pouvons maintenant commencer à nous développer. Rendez vous sur "Processus de développement Git"</li> </ol>

Processus de développement Git
Tout d'abord, NE JAMAIS DEVELOPPER SUR LA BRANCHE PRINCIPALE! Créer une branche locale de développement. Pour apprendre, reportez vous à Git-Branching-Basic-Branching-and-Merging chapter on git-scm. Ci-dessous un résumé:

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é.

Création d'une branche se fait avec : git branch myNewBranch git checkout myNewBranch 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 fait un peu de travail, validez le avec : git commit -a Contrairement à 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.

Publication de votre travail sur "sourceforge repository"
Après avoir fait des modifications sur votre branche locale, et, l'engager (commit) (cela signifie s'engager localement), vous pouvez envoyer votre référentiel sur le serveur. Cela ouvre votre branche au public, et, permet aux principaux développeurs d'examiner, et, d'intégrer votre branche en "maître". git push <REMOTENAME> <BRANCHNAME> git push origin my-branch Pour plus d'informations sur ce sujet, veuillez consulter https://help.github.com/articles/pushing-to-a-remote/

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. 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 Git Pro.

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 l’entiè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 faites beaucoup de travaux connexes, il a été suggéré 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. 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. 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.

Résolution des problèmes de merge

 * explications git-scm sur la manière dont les conflits sont présentés
 * Article de GitHub sur la résolution des problèmes de merge par la ligne de commande
 * Personnalisez votre outil de merge préféré lorsque vous rencontrez un conflit entre des git.

Resolving Merge Conflicts

 * git-scm explanation on how conflicts are presented
 * GitHub article on resolving merge conflicts via the command-line
 * Customize your preferred merge tool when you encounter a git conflict.

Application de correctifs via git
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 git appliquer [nom du correctif] .patch

Appliquer un patch via curl
Une fonctionnalité très pratique et puissante de git et de la ligne de commande est la possibilité de tester rapidement des correctifs par le terminal. curl -O https://github.com/FreeCAD/FreeCAD/commit/[patch-name].patch git apply [patch-name].patch ou bien, en utilisant des bash pipes, vous pouvez faire un sweet 1-liner: curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -


 * 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:
 * Regular GitHub page: https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621
 * 'Diffed' GitHub page: https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.diff
 * 'Patched' GitHub page: https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch

Création de correctifs à partir de git
Il est parfois nécessaire de créer un patch au lieu de soumettre un PR. Le flux de travail suivant explique comment procéder: <ol>  Assurez-vous d’être dans la bonne branche (c’est-à-dire pas dans la branche principale) en vérifiant avec git branch -v</ pre> </li>  Créez le patch: we do this by using the git format-patch command which we patch against the master branch and redirect to STDOUT. Nous créons le patch dans le répertoire en dehors de la source (afin de ne pas polluer le répertoire source lui-même, ceci est facultatif car vous pouvez choisir l'emplacement où vous voulez que le patch soit créé) git format-patch master --stdout> ../patch.name.patch </li>  Une autre méthode consiste à utiliser git format-patch HEAD^ ou git format-patch HEAD~1. Le ^ ou 1 peut être changé en nombre de commits devant être couverts, à savoir: ^^^ ou ~ 3. git format-patch HEAD^ </li> Il créera un patch ou une série de patchs avec le format de nom de fichier XXXX-commit-message.patch. Un exemple: 0001-fix-ViewProjMatrix-getProjectionMatrix.patch

</ol>

Inverser un patch dans git
Si vous avez suivi les instructions ci-dessus et que vous avez changé d'avis, vous pouvez rapidement l'inverser en utilisant: git apply -R path/file.patch ou une autre façon est d'utiliser: git checkout -f qui supprimera les modifications non validées de la branche

Stockage temporaire dans le cache des git commits
Supposons que vous travaillez sur une branche et que vous modifiez la source en dehors du champ de votre branche actuelle. En d'autres termes, il serait préférable d'ajouter certains commits à une autre branche et de les soumettre à la place du fichier actuel. C'est ici que la commande  'git stash'  peut être très utile. La commande git stash peut vous aider à stocker (temporairement mais en toute sécurité) vos modifications locales non validées. git stash Ensuite, lorsque vous souhaitez utiliser ces commits, vous pouvez faire git stash apply ou git stash pop pop supprimera le cache <BR/> Si vous avez plusieurs caches, vous pouvez faire git stash list Pour en savoir plus sur les autres fonctions que vous pouvez utiliser, consultez https://medium.freecodecamp.org/useful-tricks-you-might-not-know-about-git-stash-e8a9490f0a1a

Quelle est la dernière révision de FreeCAD Dev
Il y a 2 façons de faire cela: git rev-list --count master
 * 1ère méthode: Dans votre répertoire git cloné, tapez:
 * 2ème méthode: parcourez https://github.com/FreeCAD/FreeCAD et lisez le nombre de mises à jour de FreeCAD.

Quel est le numéro de révision d'un commit et inversement?
git rev-list --count 9948ee4 13541


 * quelques sujets du forum à ce sujet:
 * https://forum.freecadweb.org/viewtopic.php?f=10&t=26673
 * https://forum.freecadweb.org/viewtopic.php?t=5308
 * https://forum.freecadweb.org/viewtopic.php?f=18&t=12883&p=103207#p103203
 * https://forum.freecadweb.org/viewtopic.php?f=10&t=31118

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

 * https://forum.freecadweb.org/viewtopic.php?f=4&t=3025

Dépôts alternatifs
La force de Git est que tout à chacun peut cloner un projet, et commencer à modifier du code. Plusieurs contributeurs fréquents du projet FreeCAD ont leur propre dépôt Git, avec lequel ils réalisent leur travail avant que des modifications soient prêtes pour être incluses dans le code source officiel, ou avec lequel ils expérimentent simplement de nouvelles idées. Dans certains cas, vous pouvez souhaiter cloner votre code FreeCAD depuis un des ces dépôt plutôt que depuis les dépôts officiels, pour pouvoir bénéficier des changements réalisés par leur utilisateurs.

Attention cependant, vous pouvez le faire à vos risques et périls. Seul les deux dépôts ci-dessus garantissent de fonctionner et de contenir un code propre.

Attention cependant vous pouvez le faire à vos risques et périls. Seul le dépôt officiel ci-dessus est entièrement garanti pour fonctionner et contenir du code propre.

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.

Utiliser git dans une interface utilisateur graphique

 * Développer sous FreeCAD avec GitKraken

Lecture complémentaire

 * Git for the lazy
 * The entire Pro Git book