Aller au contenu principal

Git

Normes départementales d'utilisation du gestionnaire de version.

Fichiers

Un dépôt de données (repository) doit contenir que des fichiers nécessaires.

Les fichiers exécutables, les symboles de débogages, etc., doivent être inscrits au fichier « .gitignore ».

Messages

Pour un journal représentatif et agréable à lire, un format uniforme et une netteté doivent être respectés.

Format

Le format des messages doit être :

Type (Portée) : Description

Types

Le type peut être l'un des suivants :

TypeDescription
FonctionnalitéNouvelle fonctionnalité.
CorrectifCorrection de bogues ou mauvais fonctionnements.
RefactorisationRéorganisation ou réécriture.
DocumentationDocumentation.
StyleCorrections syntaxiques.
OptimisationAmélioration des performances.

Portée

La portée peut être un fichier, une classe, une méthode, une fonctionnalité, etc., et est optionnelle.

Description

La description doit être brève, et le message détaillé utilisé que si nécessaire.

Netteté

Un message devrait être amendé (amend) plutôt que dupliqué lors de modifications mineures.

Les messages insignifiants, comme les résolutions de conflits, les fusions, etc., doivent être fusionnés (squash).