Files
n3wt-school/.github/instructions/general-commit.instruction.md
2025-05-26 09:42:08 +02:00

1.1 KiB
Raw Permalink Blame History

Commit Guidelines (Conventionnel)

Les messages de commits se basent sur Conventional Commits (https://www.conventionalcommits.org/en/v1.0.0/) , pour une meilleure gestion des versions et une génération automatique du changelog.

Format standard :

<type>(<scope>): <description> [#<ticket-id>]
  • Types autorisés :

    • feat : Nouvelle fonctionnalité.
    • fix : Correction dun bug.
    • docs : Modifications liées à la documentation.
    • style : Mise en forme du code (pas de changements fonctionnels).
    • refactor : Refactorisation sans ajout de fonctionnalités ni correction de bugs.
    • test : Ajout ou modification de tests.
    • chore : Maintenance ou tâches diverses (ex. mise à jour des dépendances).
  • Scope (optionnel) : Précisez une partie spécifique du projet (backend, frontend, API, etc.).

  • Exemples :

    feat(frontend): ajout de la gestion des utilisateurs dans le dashboard [#1]
    fix(backend): correction du bug lié à l'authentification JWT [#1]
    docs: mise à jour du README avec les nouvelles instructions dinstallation [#2]