Bonnes pratiques pour les commits
Modifierℹ️ Évitez de pousser votre travail tant que vous n’êtes pas satisfait et prêt à le partager avec le reste du monde (git-scm.com).
Conventional commits
Nous utilisons conventional commits v1.0.0, veuillez consulter la documentation en ligne. Dans le message git, vous pouvez également ajouter des références aux issues GitLab sur lesquelles vous travaillez.
Voici un exemple basique montrant comment l’utiliser.
fix: init only one time the InputService
Service restarted every time when the cursor moved.
Refs: https://gitlab.e.foundation/e/backlog/-/issues/3316
Réécriture de l’historique
L’historique git est important, car il permet de connaître facilement les changements effectués dans un projet donné. Lorsqu’un nouveau contributeur découvre le projet en lisant l’historique git, il doit pouvoir comprendre certains choix ou repérer un commit pouvant entraîner une régression.
Ainsi, pour que l’historique git reflète le travail effectué, il est important de pouvoir réécrire l’historique des commits de votre branche de développement avant de la soumettre ou lorsqu’un relecteur formulera des commentaires. Nous ne voulons pas introduire des messages de commit du type lint ou apply review suggestion. De tels commits doivent être squashés.
Voici une documentation en ligne pour vous aider à réécrire votre historique git.