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.

Accès
Tout le monde peut accéder au code source de FreeCAD et en obtenir une copie, mais seulement les managers du projets ont les droits pour y écrire. 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.

La procédure décrite ci-dessous montre comment obtenir une copie du code source de FreeCAD depuis un de nos deux dépôts officiels :

Depuis Github
Un façon simple de commencer à travailler avec le code source de FreeCAD est d'utiliser github Même si le dépôt Git officiel de FreeCAD est actuellement hébergé sur Sourceforge (voir ci-dessous), nous maintenons également un miroir automatique de la branche "master" sur ce dépôt github : https://github.com/FreeCAD/FreeCAD_sf_master

Vous pouvez simplement utiliser le bouton "fork" au sommet de la page. Cela va créer une copie du dépôt FreeCAD sur votre propre compte github. La procédure se déroule généralement de la manière suivante :
 * 1) Se créer un compte Github
 * 2) Aller sur
 * 3) Cliquer sur le bouton "fork"
 * 4) Clonez votre nouveau fork de freeCAD sur votre ordinateur
 * 5) Faites vos modification sur le code
 * 6) Créez une nouvelle branche
 * 7) Extraire cette nouvelle branche (Checkout to that branch)
 * 8) Soumettre (Commit) vos changement à cette nouvelle branche
 * 9) Publiez (Push) cette nouvelle branche sur votre dépôt Github

Vous pouvez aussi commencer normalement, sans utiliser le bouton "fork" :
 * 1) Clonez le code FreeCAD avec Git
 * 2) Faites vos changements sur le code source
 * 3) Créez une nouvelle branche
 * 4) Extraire cette nouvelle branche (Checkout to that branch)
 * 5) Soumettre (Commit) vos changement à cette nouvelle branche
 * 6) Créez-vous un compte sur un serveur Git public (github, gitorious, sourceforge ou n'importe quel autre)
 * 7) Publiez (Push) votre branche sur ce serveur

Note importante: Parce que notre dépôt Github est uniquement un miroir, nous ne le surveillons pas activement. Par conséquent, ne l'utilisez pas pour vos requêtes "pull". Si vous avez du code que vous souhaitez voir intégré dans le code source de FreeCAD, merci poster à la place un mot sur la section pull requests du forum FreeCAD.

Via Sourceforge
Pour accéder à un dépôt Git, configurez votre client Git comme suit :

git://free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (read-only) ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (read/write)

Règles d'accès
A ceux qui veulent participer : nous donnerons, à toutes personnes intéressées, un accès en écriture sur le dépôt git aussi longtemps que vous restez loin de la branche principale (conseil).

Authentification
L'accès en lecture seule ne demande pas de mot de passe.

L'accès lecture/écriture, utilise votre mot de passe SSH, ou une clé SSH, pour autoriser votre accès. Pour effectuer des opérations d'écriture, votre administrateur de projet, doit vous accorder l'accès en écrivez au référentiel.

Remarque : Dans tous les exemples ci-dessous, USERNAME représente votre compte utilisateur chez SourceForge.net.

Comment cloner le dépôt
Vous pouvez simplement cloner votre dépôt distant, et, vous mettre au travail : git clone ssh://USERNAME@git.code.sf.net/p/free-cad/code REPONAME cd REPONAME La première fois que vous essayez de vous connecter à l'hôte de free-cad.git.sourceforge.net, vous devriez voir un message similaire à celui-ci : The authenticity of host 'git.code.sf.net (216.34.181.91)' can't be established. RSA key fingerprint is 86:7b:1b:12:85:35:8a:b7:98:b6:d2:97:5e:96:58:1d. Are you sure you want to continue connecting (yes/no)? Avant de taper «oui» et accepter la signature d'accueil, assurez vous que la signature digitale est correct pour l'hôte. Vous pouvez trouver une liste de clés d'hôtes SSH dans la liste des clés SSH, des signatures hôte. Si vous recevez un avertissement de clé d'hôte, s'il vous plaît contacter l'équipe SourceForge.net.

Configuration de votre nom d'utilisateur git
Les utilisateurs doivent s'engager à leur référentiel de projet, en utilisant leur nom d'utilisateur SourceForge.net. 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 "USERNAME@users.sourceforge.net" 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.

Depuis des 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.

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.

Développement
Tout d'abord, ne jamais développer sur la branche principale ! Créer une branche locale de développement. Vous pouvez apprendre comment la faire ici.

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 my-branch

Publication sur un autre référentiel
Git vous permet également de fusionner des branches, de plus d'un référentiel. Si vous n'avez pas accès en écriture au dépôt Git hébergé sur sourceforge FreeCAD, vous pouvez également configurer un compte sur n'importe quel hôte autre que Git, comme github ou gitorious et le faire savoir aux autres, afin que vos modifications soient accessibles à partir de là.

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.

Lecture complémentaire

 * Git for the lazy
 * Git pro on-line book