Gestion du code source

From FreeCAD Documentation
Revision as of 14:32, 30 August 2012 by Mario52 (talk | contribs) (création et traduction de la page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Source_code_management/fr

Prochainement, notre principal outil de gestion de code source sera Git. Cet article, vous explique comment l'utiliser, et, que sont les règles générales applicables dans le cas de FreeCAD.

Pendant un certain temps, nous gardons le dépôt SVN sur sf.net. Il est possible de valider les modifications dans le SVN et Git. Je fais de temps en temps une fusion de l'un à l'autre par l'intermédiaire d'un référentiel gatekeeper.
Ce n'est possible, que comme transition. Je recommande fortement aux développeurs de passer à SVN et Git, dès une possible!

Accès

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@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad 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 'free-cad.git.sourceforge.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.

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


Traductions disponibles: Flag-en.jpg Flag-es.jpg