Règle a respecter pour les commentaires lors des commit SVN
Regles de publications SVN
Généralités
- Toute ligne de commentaire doit être précédé d'un prefixe choisi dans la liste décrite ci-dessous
- Un commentaire comportant plusieurs lignes comportera donc autant de préfixes que de lignes
- La description de la modification doit être aussi explicite que possible (pas d'abrévation, nom du module / de la classe / de la tabulation, ...)
Liste des préfixes à utiliser
-
Erg - Modification de l'ergonomie de l'interface
-
Fnc - Nouvelle fonctionnalité ajoutée au système
-
Bug - Correction de bug.
-
Ref - Refactoring, y compris modification du framework et sa propagation, nettoyage de code, factorisation.
-
Sys - Modification système (mise à jour du numéro de version, opération svn, etc...)
-
Wrn - Avertissement d'action importante à effectuer (réinstallation d'une bibliothèque, mise à jour d'un module, etc...)
-
Tst - Opération temporaire afin d'effectuer des tests sur l'appli depuis d'autres serveurs
Exemples
Erg: Modification de la couleur des en-têtes de tableau Fnc: Possibilité de revenir en arrière après une commande de produit Bug: Bouton d'impression inactif dans le dossier patient Ref: Passage au chargement automatique par Smarty des champs texte Sys: Ajout des fichiers .back au svn ignore Wrn: Mettre a jour la bibliothèque scriptaculous Tst: Affichage des informations transmises dans la création d'un séjour dans les logs
Dernièrement modifié par mytto
, Basé sur le travail de
rhum1
.
Modifiée dernièrement le lundi 01 de décembre, 2008 14h26m05.
