Python   •   ReactJS   •   React Native   •   Laravel   •   NestJS   •   Docker   •   Jupyter Notebook

Projet COSAMED

État du projet

• ✅ Fonctionnalités de base implémentées
• 🐛 Correction des bugs critiques en cours
• 🚀 Déploiement prévu pour la semaine prochaine

Guide de Rédaction des Messages de Commit Git pour l’Organisation COSAMED

Ce guide a pour objectif d’harmoniser la manière dont nous rédigeons les messages de commit dans tous les dépôts de notre organisation GitHub pour faciliter la compréhension, la traçabilité et la collaboration au sein de nos équipes.

Structure du Message de Commit

Un message de commit se compose de trois parties distinctes, séparées par une ligne vide :

type: Sujet

Corps (optionnel)

Footer (optionnel)

Mais ce n'est pas a tout moment que nous devons utiliser the corps and Footer. Example d'un simple commit:

Feat: Ajout d'une fonctionalité avec redis

• type : indique la nature du changement (voir ci-dessous).
• Sujet : résumé clair et concis du changement, en 50 caractères maximum, commençant par une majuscule, sans point final.
• Corps : explique ce que fait le commit et pourquoi, pas comment. À utiliser uniquement si nécessaire.
• Footer : référence les issues ou tickets liés (ex : Résout : #123).

Types de Commits

Utilisez l’un des types suivants en début de message, suivi de deux-points et d’un espace :

• feat : ajout d’une nouvelle fonctionnalité
• fix : correction d’un bug
• docs : modification ou ajout dans la documentation
• style : changements de formatage, indentation, espaces, sans impact sur le code
• refactor : modification du code sans ajout ni correction de fonctionnalité
• test : ajout ou modification de tests, sans impact sur le code de production
• chore : tâches de maintenance, mise à jour de configurations, scripts, etc.

Bonnes Pratiques

• Rédigez les messages au mode impératif : par exemple, Ajoute la gestion des erreurs et non Ajouté ou Ajoute.
• Limitez la longueur des lignes du corps à 72 caractères.
• N’utilisez pas de point à la fin du sujet.
• Séparez toujours le sujet du corps par une ligne vide.
• Expliquez dans le corps pourquoi le changement est fait, pas comment (le code montre le comment).
• Si vous faites référence à une issue, indiquez-le dans le footer, par exemple : Résout : #45

Recommandations pour le Travail Collaboratif

• Travaillez toujours dans une branche dédiée autre que main (exemple : feature/nom-fonctionnalite, fix/nom-bug) afin de préserver la stabilité de la branche principale.
• Faites des commits fréquents et ciblés, chaque commit doit représenter un changement unique et cohérent.
• Portez une attention particulière aux issues (#numéro) ouvertes dans chaque dépôt : mentionnez-les dans vos commits pour faciliter le suivi.
• Documentez votre code de manière claire et concise pour faciliter la compréhension et la maintenance.
• Assurez-vous que la documentation du dépôt est à jour : tout changement fonctionnel ou structurel important doit être reflété dans les fichiers README ou équivalents.

---

• ✅ Tâche terminée
• 🐛 Correction de bug
• ✨ Nouvelle fonctionnalité
• 📝 Documentation
• 🚀 Déploiement
• ⚠️ Attention / Avertissement
• 🔒 Sécurité
• 📱 Mobile
• 💻 Web