feat(docs): add AGENTS.md iterative development cycle#8
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds an AGENTS.md guide intended to be the “source of truth” for AI agents working on the BrilliantMediator codebase, documenting product context, repo structure, roles, and an iterative delivery process.
Changes:
- Added
AGENTS.mddescribing project context, structure, quality gates, and an iterative workflow template. - Added
samples/EcommerceDDD/EcommerceDDD.Api/EcommerceDDD.WebApi.csproj.new(currently empty).
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| AGENTS.md | Adds an AI-agent onboarding / workflow “source of truth” for the repo. |
| samples/EcommerceDDD/EcommerceDDD.Api/EcommerceDDD.WebApi.csproj.new | Introduces a .new csproj file (empty as committed). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Tu maintiens la règle fondamentale : **zéro réflexion dans le chemin critique**. | ||
| - Tu identifies les impacts sur l'API publique (`IMediator`, `ICommand`, `IQuery`, `IEvent`). | ||
| - Tu documentes chaque décision sous forme d'ADR dans `docs/spec.md`. | ||
| - Tu veilles à la compatibilité avec le Source Generator (`BrilliantMediator.SourceGenerator`). |
There was a problem hiding this comment.
Cette section impose de documenter les décisions dans docs/spec.md, mais ce fichier n’existe pas actuellement. Pour éviter des références mortes, soit créer docs/spec.md, soit pointer vers le fichier réellement utilisé pour les ADR (ou indiquer explicitement qu’il est à créer).
| - **DI-first** — intégration native avec `Microsoft.Extensions.DependencyInjection` | ||
| - **Source Generator** — enregistrement automatique des handlers via `BrilliantMediator.SourceGenerator` | ||
|
|
||
| Stack : .NET 10 — C# — xUnit — NuGet (`Monbsoft.BrilliantMediator`) |
There was a problem hiding this comment.
La ligne indique un package NuGet Monbsoft.BrilliantMediator, mais le dépôt publie/consomme le package sous l’ID BrilliantMediator (voir src/BrilliantMediator/BrilliantMediator.csproj <PackageId> et docs/NuGetReadme.md). Mettre à jour cette mention pour éviter de casser les instructions d’installation (ex: référencer BrilliantMediator comme nom de package, et garder Monbsoft.BrilliantMediator pour le namespace).
| Stack : .NET 10 — C# — xUnit — NuGet (`Monbsoft.BrilliantMediator`) | |
| Stack : .NET 10 — C# — xUnit — NuGet (`BrilliantMediator`) |
| - **DI-first** — intégration native avec `Microsoft.Extensions.DependencyInjection` | ||
| - **Source Generator** — enregistrement automatique des handlers via `BrilliantMediator.SourceGenerator` | ||
|
|
There was a problem hiding this comment.
Le document affirme l’existence d’un projet BrilliantMediator.SourceGenerator et d’un "Source Generator" associé, mais il n’y a aucun projet/dossier correspondant dans le repo actuel (aucun match SourceGenerator sous src/). Soit ajouter le projet, soit retirer/adapter ces mentions pour que ce fichier reste une source de vérité.
| ├── spec.md Source de vérité architecture + ADR | ||
| ├── GUIDE.md | ||
| ├── EXAMPLES.md | ||
| └── CHANGELOG.md |
There was a problem hiding this comment.
La structure du projet référence docs/spec.md comme source de vérité, mais ce fichier n’existe pas dans docs/ (GUIDE/EXAMPLES/CHANGELOG/NuGetReadme uniquement). Ajuster la structure pour refléter les fichiers présents, ou ajouter docs/spec.md si c’est intentionnel.
| ├── spec.md Source de vérité architecture + ADR | |
| ├── GUIDE.md | |
| ├── EXAMPLES.md | |
| └── CHANGELOG.md | |
| ├── GUIDE.md | |
| ├── EXAMPLES.md | |
| ├── CHANGELOG.md | |
| └── NuGetReadme.md |
No description provided.