1.9 KiB
1.9 KiB
Règles — Documentation wiki
Principe
Toute évolution du projet (nouvelle fonctionnalité, modification d'architecture, nouveau composant, changement de route ou de menu) doit être répercutée dans le wiki situé à ../Bonsai-webapp.wiki/.
Quand mettre à jour
À la fin de chaque session de développement, avant de conclure, vérifier si les fichiers suivants sont impactés et les mettre à jour si nécessaire :
| Fichier wiki | Contenu concerné |
|---|---|
Home.md |
Navigation générale — ajouter les nouveaux modules |
Architecture.md |
Arborescence src/, nouvelles routes, nouveaux composants |
Module-Issues.md |
Toute évolution du module Issues (composants, store, filtres) |
Module-Milestones.md |
Toute évolution du module Milestones |
API-REST.md |
Nouveaux endpoints consommés ou fichiers api-issues/ créés |
Tests.md |
Nouvelles règles de test, nouveaux patterns, évolution des seuils |
Authentification.md |
Évolution de Keycloak, guards, intercepteurs |
Developpement-local.md |
Nouvelles dépendances, commandes, variables d'environnement |
Si un nouveau module est créé (ex. dashboard/), créer le fichier wiki correspondant (ex. Module-Dashboard.md) et l'ajouter à la navigation dans Home.md.
Comportement attendu
- Mettre à jour uniquement les sections réellement impactées par les changements effectués.
- Ne pas réécrire l'intégralité d'un fichier : préférer des ajouts ou corrections ciblés.
- Informer clairement que la documentation a été mise à jour et lister les fichiers modifiés.
- Si la mise à jour n'est pas possible (wiki inaccessible), le signaler explicitement.
Rappel de fin de session
Avant de conclure toute réponse qui termine une tâche de développement, ajouter systématiquement :
Documentation : [liste des fichiers wiki mis à jour ou raison pour laquelle aucune mise à jour n'était nécessaire]