📁 .github

Ce dossier contient les templates et configurations GitHub pour BusinessPlanBuilder.

📄 Fichiers

PULL_REQUEST_TEMPLATE.md

Template automatiquement affiché lors de la création d'une Pull Request.

Sections :

• Description des changements
• Type de changement (bug, feature, refactor, etc.)
• Checklist complète (code, docs, tests, qualité, UI/UX, performance)
• Screenshots avant/après
• Instructions de test
• Points d'attention

Utilisation : Lors de la création d'une PR sur GitHub, ce template s'affiche automatiquement. Remplir toutes les sections applicables et cocher les cases de la checklist.

---

ISSUE_TEMPLATE/

Dossier contenant les templates pour les issues GitHub.

bug_report.md

Template pour signaler un bug ou dysfonctionnement.

Sections :

• Description du bug
• Étapes pour reproduire
• Comportement attendu vs actuel
• Environnement (navigateur, OS)
• Logs / Messages d'erreur

feature_request.md

Template pour proposer une nouvelle fonctionnalité.

Sections :

• Problème / Besoin
• Solution proposée
• Alternatives considérées
• Impact sur le projet
• Priorité suggérée

documentation.md

Template pour amélioration de documentation.

Sections :

• Type de documentation concernée
• Problème actuel
• Amélioration proposée
• Section concernée

---

🎯 Workflow

Créer une Issue

1. Aller sur GitHub → Issues → New Issue
2. Choisir le template approprié
3. Remplir toutes les sections
4. Assigner des labels appropriés
5. Soumettre

Créer une Pull Request

1. Créer une branche : git checkout -b feature/ma-feature
2. Faire les modifications
3. Commit : git commit -m "feat(scope): description"
4. Push : git push origin feature/ma-feature
5. Créer la PR sur GitHub
6. Remplir le template (affiché automatiquement)
7. Cocher toutes les cases de la checklist
8. Demander une review

---

📋 Labels Recommandés

Créer ces labels dans GitHub :

Type :

• bug 🐛 - Correction de bug
• enhancement ✨ - Nouvelle fonctionnalité
• documentation 📚 - Documentation
• refactor ♻️ - Refactoring
• performance ⚡ - Amélioration performance
• test ✅ - Tests

Priorité :

• priority: high 🔴 - Priorité haute
• priority: medium 🟠 - Priorité moyenne
• priority: low 🟢 - Priorité basse

Statut :

• in progress 🚧 - En cours
• needs review 👀 - Besoin de review
• blocked 🚫 - Bloqué

Module :

• module: actionplan 📋
• module: marketing 📣
• module: finances 💰
• module: common 🧩

---

✅ Best Practices

Pour les PR

1. Une PR = Une fonctionnalité - Ne pas mélanger plusieurs changements non liés
2. Titre descriptif - Format : type(scope): description
3. Cocher toutes les cases - Valider la checklist complète
4. Screenshots obligatoires - Pour tout changement visuel
5. Tests documentés - Expliquer comment tester

Pour les Issues

1. Titre clair - Résumer le problème en une phrase
2. Étapes de reproduction - Pour les bugs, décrire précisément
3. Environnement - Toujours spécifier navigateur et OS
4. Assignation - S'assigner si on travaille dessus

Code Review

1. Review sous 24h - Priorité aux PR en attente
2. Commentaires constructifs - Expliquer le "pourquoi"
3. Approuver explicitement - Utiliser le bouton "Approve"
4. Tester localement - Pull la branche et tester

---

Dernière mise à jour : 14 novembre 2025
Maintenu par : L'équipe BusinessPlanBuilder