Convention pour les commits

Un commit correspond à l'enregistrement de l'état d'un ou des fichiers. Chaque commit est enregistré localement sur votre poste, il est transmis au serveur au moment de la commande:

git push

Il est recommandé de faire des commits régulièrement après la réalisation de tâche unitaire, par exemple la modification d'une fonction.

Ajout de fichiers

Lorsque vous créé un nouveau fichier (ou plusieurs), il faudra indiquer à git que le nouveau fichier doit être suivi:

git add toto/le_nouveau_fichier.py

Il faudra ensuite enregistrer cet ajout dans un commit.

Commit

Une opération de commit associe des modifications et un commentaire.

Vous pouvez voir les modifications actuelles avec:

git status

Vous pouvez enregistrer toutes les modifications en cours à l'aide du paramètre -a, ou seulement indiquer le ou les modifications à enregistrer.

Il faudra également indiquer un commentaire, le commentaire doit respecter la forme suivante: TYPE(PORTÉE): MESSAGE #NB

Avec le TYPE sur 3 lettres:

• add: ajout d'une fonctionnalité
• del: suppression d'un élément
• enh: une amélioration
• fix: résolution d'une erreur ou d'un bug

La PORTÉE qui peut correspondre à:

• user: pour la classe User
• settings: pour la partie configuration
• doc: changement dans la documentation
• test: tout ce qui concerne les tests
• ...

Et NB qui correspond au numéro de la demande sur gitlab.

L'option -m permet de directement saisir le commentaire.

Voici quelques exemples:

# enregistrement de toutes les modifications en attente
git commit -a -m "add(models): class Semestre #42"
# enregistrement des modifications seulement dans un fichier
git commit -m "fix(views): boutons en trop #42" core/template/core/fichier.html

Voir les messages de commit

Vous pouvez visualiser tous les messages de commit avec par exemple:

git log --oneline