📝Conventional Commits

L'utilisation des Conventional Commits sur le GitHub de Papillon est facultative, mais elle contribue à améliorer la lisibilité du code pour tous les contributeurs.

Cette convention de commits est une adaptation des Conventional Commits standard, conçue pour le projet Papillon. Elle permet de garder une description et une étendue optionnelle en français, tout en conservant le type de commit en anglais, comme le préconise la convention originale.

Structuration

<type>[étendue optionnelle]: <description>

[corps optionnel]

[pied optionnel]

• Type: Indique le type de modification apportée (feat, fix, etc.).

• Étendue: Champ optionnel décrivant la partie du code concernée (entre parenthèses).

• Description: Brève description du changement.

• Corps: Informations contextuelles supplémentaires sur le changement (paragraphes séparés par des sauts de ligne).

• Pied: Informations complémentaires, comme les personnes ayant révisé le code ou des références liés (lignes séparées par des sauts de ligne).

Types de commit

Feat

Introduit une nouvelle fonctionnalité dans le code.

feat: implémenter le suivi des absences des élèves

Fix

Corrige un bogue ou un problème dans le code.

fix(notification): correction du problème de notification

Chore

Modifications des tâches de maintenance du code, telles que la mise à jour des dépendances ou la configuration des outils.

chore: mise à jour des dépendances React-Paper

Test

Ajouts ou modifications de tests unitaires ou d'intégration.

test: logique de calcul des absences

Docs

Modifications apportées à la documentation du code.

docs(README.md): correction d'une faute de frappe

Styles

Modifications apportées au formatage du code, à la structure ou aux conventions de nommage.

styles: supprimer les lignes de code vides inutiles

Refactor

Modifications apportées à la structure du code pour améliorer sa lisibilité, sa maintenabilité ou ses performances sans modifier son comportement.

refactor: optimisation de la requête Pawnote in-app

Perf

Améliorations des performances du code.

perf: optimisation de la requête Pawnote in-app

BREAKING CHANGE

Introduit une rupture de compatibilité dans l'API ou le comportement du code.

BREAKING CHANGE(absences): modifier le format des données d'absence des élèves

L'ancien format était `[date] [motif]`. Le nouveau format est `{"date": "[date]", "motif": "[motif]"}`.

Rappels

• Ajoutez une nouvelle ligne avant le corps étendu du commit.

• Plus de détails sur conventionalcommits.org.