BMAD-METHOD/docs/fr/explanation/project-context.md

7.9 KiB
Raw Blame History

title description sidebar
Contexte du Projet Comment project-context.md guide les agents IA avec les règles et préférences de votre projet
order
12

Le fichier project-context.md est le guide dimplémentation de votre projet pour les agents IA. Similaire à une «constitution» dans dautres systèmes de développement, il capture les règles, les patterns et les préférences qui garantissent une génération de code cohérente à travers tous les workflows.

Ce Quil Fait

Les agents IA prennent constamment des décisions dimplémentation — quels patterns suivre, comment structurer le code, quelles conventions utiliser. Sans guidance claire, ils peuvent :

  • Suivre des bonnes pratiques génériques qui ne correspondent pas à votre codebase
  • Prendre des décisions incohérentes selon les différentes stories
  • Passer à côté dexigences ou de contraintes spécifiques au projet

Le fichier project-context.md résout ce problème en documentant ce que les agents doivent savoir dans un format concis et optimisé pour les LLM.

Comment Ça Fonctionne

Chaque workflow dimplémentation charge automatiquement project-context.md sil existe. Le workflow architecte le charge également pour respecter vos préférences techniques lors de la conception de larchitecture.

Chargé par ces workflows :

  • bmad-create-architecture — respecte les préférences techniques pendant la phase de solutioning
  • bmad-create-story — informe la création de stories avec les patterns du projet
  • bmad-dev-story — guide les décisions dimplémentation
  • bmad-code-review — valide par rapport aux standards du projet
  • bmad-quick-dev — applique les patterns lors de limplémentation des spécifications techniques
  • bmad-sprint-planning, bmad-retrospective, bmad-correct-course — fournit le contexte global du projet

Quand Le Créer

Le fichier project-context.md est utile à nimporte quel stade dun projet :

Scénario Quand Créer Objectif
Nouveau projet, avant larchitecture Manuellement, avant bmad-create-architecture Documenter vos préférences techniques pour que larchitecte les respecte
Nouveau projet, après larchitecture Via bmad-generate-project-context ou manuellement Capturer les décisions darchitecture pour les agents dimplémentation
Projet existant Via bmad-generate-project-context Découvrir les patterns existants pour que les agents suivent les conventions établies
Projet Quick Dev Avant ou pendant bmad-quick-dev Garantir que limplémentation rapide respecte vos patterns

:::tip[Recommandé] Pour les nouveaux projets, créez-le manuellement avant larchitecture si vous avez de fortes préférences techniques. Sinon, générez-le après larchitecture pour capturer ces décisions. :::

Ce Quil Contient

Le fichier a deux sections principales :

Pile Technologique & Versions

Documente les frameworks, langages et outils utilisés par votre projet avec leurs versions spécifiques :

## Pile Technologique & Versions

- Node.js 20.x, TypeScript 5.3, React 18.2
- State: Zustand (pas Redux)
- Testing: Vitest, Playwright, MSW
- Styling: Tailwind CSS avec design tokens personnalisés

Règles Critiques dImplémentation

Documente les patterns et conventions que les agents pourraient autrement manquer :


## Règles Critiques dImplémentation

**Configuration TypeScript :**
- Mode strict activé — pas de types `any` sans approbation explicite
- Utiliser `interface` pour les APIs publiques, `type` pour les unions/intersections

**Organisation du Code :**
- Composants dans `/src/components/` avec fichiers `.test.tsx` co-localisés
- Utilitaires dans `/src/lib/` pour les fonctions pures réutilisables
- Les appels API utilisent le singleton `apiClient` — jamais de fetch direct

**Patterns de Tests :**
- Les tests unitaires se concentrent sur la logique métier, pas sur les détails dimplémentation
- Les tests dintégration utilisent MSW pour simuler les réponses API
- Les tests E2E couvrent uniquement les parcours utilisateurs critiques

**Spécifique au Framework :**
- Toutes les opérations async utilisent le wrapper `handleError` pour une gestion cohérente des erreurs
- Les feature flags sont accessibles via `featureFlag()` de `@/lib/flags`
- Les nouvelles routes suivent le modèle de routage basé sur les fichiers dans `/src/app/`

Concentrez-vous sur ce qui est non évident — des choses que les agents pourraient ne pas déduire en lisant des extraits de code. Ne documentez pas les pratiques standard qui sappliquent universellement.

Création du Fichier

Vous avez trois options :

Création Manuelle

Créez le fichier _bmad-output/project-context.md et ajoutez vos règles :

# Depuis la racine du projet
mkdir -p _bmad-output
touch _bmad-output/project-context.md

Éditez-le avec votre pile technologique et vos règles dimplémentation. Les workflows architecture et implémentation le trouveront et le chargeront automatiquement.

Générer Après LArchitecture

Exécutez le workflow bmad-generate-project-context après avoir terminé votre architecture :

bmad-generate-project-context

Cela analyse votre document darchitecture et vos fichiers projet pour générer un fichier de contexte capturant les décisions prises.

Générer Pour Les Projets Existants

Pour les projets existants, exécutez bmad-generate-project-context pour découvrir les patterns existants :

bmad-generate-project-context

Le workflow analyse votre codebase pour identifier les conventions, puis génère un fichier de contexte que vous pouvez examiner et affiner.

Pourquoi Cest Important

Sans project-context.md, les agents font des suppositions qui peuvent ne pas correspondre à votre projet :

Sans Contexte Avec Contexte
Utilise des patterns génériques Suit vos conventions établies
Style incohérent selon les stories Implémentation cohérente
Peut manquer les contraintes spécifiques au projet Respecte toutes les exigences techniques
Chaque agent décide indépendamment Tous les agents salignent sur les mêmes règles

Cest particulièrement important pour :

  • Quick Dev — saute le PRD et larchitecture, le fichier de contexte comble le vide
  • Projets déquipe — garantit que tous les agents suivent les mêmes standards
  • Projets existants — empêche de casser les patterns établis

Édition et Mise à Jour

Le fichier project-context.md est un document vivant. Mettez-le à jour quand :

  • Les décisions darchitecture changent
  • De nouvelles conventions sont établies
  • Les patterns évoluent pendant limplémentation
  • Vous identifiez des lacunes dans le comportement des agents

Vous pouvez léditer manuellement à tout moment, ou réexécuter bmad-generate-project-context pour le mettre à jour après des changements significatifs.

:::note[Emplacement du Fichier] Lemplacement par défaut est _bmad-output/project-context.md. Les workflows le recherchent là, et vérifient également **/project-context.md nimporte où dans votre projet. :::