Gestion du code source

From FreeCAD Documentation
Revision as of 14:20, 17 March 2015 by Yinameah (talk | contribs) (Created page with "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'ap...")

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.

There are also many good graphical clients to git, such as git-cola, that make the whole process of managing git repositories easier.

Access

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 pull requests section of the FreeCAD forum.

The procedure below show how to get a copy of the FreeCAD source code, from one of our two official repositories:

From Github

An easy way to start with the FreeCAD source code is using github. While the official FreeCAD Git repository is currently hosted on Sourceforge (see below), we also maintain an automatic mirror of the master branch on this github repository: https://github.com/FreeCAD/FreeCAD_sf_master

You can start simply by using the "fork" button on top of the above page. This will create a copy of the FreeCAD repository on your own github account. The general procedure is as follows:

  1. Create yourself a github account
  2. Go to https://github.com/FreeCAD/FreeCAD_sf_master
  3. Pres the "fork" button
  4. On your machine, clone your newly created freecad fork
  5. Do your changes to the code
  6. Create a new branch
  7. Checkout to that new branch
  8. Commit your changes to that new branch
  9. Push that new branch to your github repo

You can also start normally, without using the "fork" button:

  1. clone the FreeCAD code with git
  2. Do your changes to the code
  3. create a new branch
  4. Checkout to that new branch
  5. Commit your changes to that new branch
  6. Create yourself an account on a public git server (github, gitorious, sourceforge or any other)
  7. Push your branch to that server

important Note: As our github repository is only a mirror, we don't watch it very carefully. Therefore, please don't use it for pull requests. If you have code you wish to see merged into the FreeCAD source code, please post a note in the pull requests section of the FreeCAD forum instead.

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.

From 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 two official repositories above are fully guaranteed to work and contain clean code.

It is also possible to attach several remote repositories to a same local FreeCAD git code, using the "git remote" command. This is useful to keep in sync with the master code branch, but keep an eye on the work of different developers.

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