ETQ Dev je voudrais un template/modèle de commit à jour
Validation
Ce template de commit permet de s'assurer que tous les développeur.ses adoptent les mêmes standard de développement. La liste des modifications apportées est claire et explicite.
-
Il y a un paragraphe dans le README qui explique comment activer le template de commit. -
C'est visible dans la capture ci-dessous -
C'est visible sur le site web de la documentation du package: https://propre-conj.pages.lab.sspcloud.fr/conj.region/#d%C3%A9velopeursses
-
-
Si je regarde la page de la liste des commits, je vois qu'ils respectent tous un standard dans le titre et dans le contenu -
Sur une capture d'écran déroulée -
La liste des commits en temps réel: https://git.lab.sspcloud.fr/propre-conj/conj.region/-/commits/main
-
Comment Technique
Côté Dev ThinkR
Les devs disposent de la nouvelle template de commit et l'ont activé.
Merci au dev de cocher les cases quand ceci est fait:
Actions
-
Mettre à jour le ficher .gitlab/template_commit
avec la template ci-dessous. -
Chacun des devs doit relancer la commande: git config --global commit.template .gitlab/template_commit
-
Ajouter un paragraphe dans le README pour s'assurer que tout nouveau dev puisse activer cette template.
Template de commit
# Define a direct explicit title with main tag
# Example: feat: Create my_fun to build xml
# 50-character subject line
# Add an empty line after that title
# Note that all lines that starts with #, will not be included
# in your commit message
# Choose one or more tags to add: the main and the secondary ones
# Possible tags from most to less important (see more info below):
# ci, fix, feat, doc, test, refactor, style, chore
tags:
Pourquoi :
-
Comment :
-
# List corresponding issues
# example :Issue #12
# Be careful with # as it will not be commit if line starts with #
Issues
issue #
# Explication des tags:
# ci : tout ce qui touche au ci, meme les fix du ci pour l'instant
# fix : correction d'un bug dans la code base
# feat : l'ajout d'une nouvelle feature
# doc : doc du package, on devrait voir que ça la sur ces 3 jours en gros
# test: pour les tests unitaires
# refactor : Refactoring de code, comme de la factorisation, du déplacement de code
# style : pour la mise en forme de code, tabulation, ...
# chore: tout ce qui touche au projet en lui même, des tâches de fond classiques,
# comme une montée de version
# Exemple of commit
# feat: a wonderful new feature - part 1
#
# tags: feat, doc, test
#
# Why?
#
# - There is a need for this feature
#
# What?
#
# - Created this
# - Started implementation of that
#
# issue #123
Edited by Marc Henninger