Utilisation de subversion - Les 5 règles d'or

[Damien Cuvillier]

Bonjour

Suite à quelques problèmes lors de l'utilisation de subversion, voici un document faisant office de référence quant à l'utilisation de subversion au sein du projet CodeSquale.
Tout développeur souhaitant participer au projet est prié de suivre ces quelques règles simples afin de maintenir une cohérence et un bon fonctionnement du projet.

Comment utiliser Subversion ?
Subversion dispose de nombreux logiciels clients se permettant de travailler efficacement avec. Il peut s'agit de logiciels autonomes tels que RapidSVN ou de plugin à un environnement donné : l'explorateur windows (TortoiseSVN), Eclipse (Subclipse), Visual Studio (AnkhSVN)…
Ces outils permettent d'éviter d'utiliser subversion en ligne de commande en fournissant de nombreux outils et assistants.

Les 5 règles d'or
Les règles citées ci-dessous devront être suivie le plus souvent possible afin de garantir la maintenabilité, l'efficacité et l'homogénéité des projets.

• Le dépôt subversion ne doit contenir strictement que les fichiers nécessaires à la compilation puis l'utilisation du projet.
  Donc, si la source du dépôt SVN est un projet Eclipse, supprimer les fichiers commençant par '.' (ex : .project), le répertoire build, tous les fichiers qui n'ont pas à se trouver dans le package final et qui risque de gêner d'autres développeurs participants au projet.
• Penser à mettre un commentaire à chaque commit. Cela va faciliter les éventuels retours en arrière, merge, ... dans le dépôt subversion.
  Il peut être intéressant de placer des « flag » sur chaque commentaire de la manière suivante :
• [ADD] commentaire : si on ajoute un fichier
• [DEL] commentaire : si on supprime un fichier
• [BUG] commentaire : si on corrige un bug
• [UPD] commentaire : si on modifie un fichier
• Il est préconisé de réaliser un update avant tout commit pour vérifier que l'on possède la dernière version du projet.
• Afin d'éviter des « merges » trop massifs, il est conseillé de réaliser des « commits » le plus fréquemment possible.
• Les classes et fichiers contenus dans chaque commit doivent, dans la mesure du possible, ne poser aucun problème à la compilation du projet global

Merci de votre investissement

Damien Cuvillier
    Ingénieur étude et architecture
    Ajilon
    Tél : 06.73.35.21.66
    Email : damien.c...@gmail.com

Please consider your environmental responsibility before printing this e-mail.