chore: add AI coding assistant context files - #300
Conversation
Adds a comprehensive AGENTS.md file to provide AI coding assistants (Claude Code, GitHub Copilot, OpenAI Codex, Cursor) with the project context needed to give accurate, convention-aware assistance without re-exploring the repository each session. Covers: project purpose, repository layout, build/test/pack commands, architecture and extension model (with Mermaid diagrams), public API, test conventions (BDD naming, AAA structure), coding conventions, analyser enforcement, dependency management, versioning, CI/CD overview, and local developer setup. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
CLAUDE.md imports AGENTS.md and adds the single Claude Code-specific instruction (plan mode for non-trivial changes). AGENTS.md gains a new "AI Agent Working Rules" section covering: propose before acting, prefer dotnet build for verification, never commit autonomously, one logical change per commit, and an explicit list of changes requiring approval (solution files, workflows, shared build config, cross-module changes). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds a dedicated Installation section with dotnet add package commands for each supported mocking library, and a Contributing section pointing to AGENTS.md for project context and conventions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThree documentation files are added or modified to establish contributor guidance, project architecture overview, and installation instructions. No code logic, APIs, or build processes are altered—only documentation is introduced to inform developers and AI assistants. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 111-148: The Mermaid classDiagram uses an invalid combined
stereotype `<<abstract, Core>>` on AutoDataBaseAttribute; change it to a single
stereotype `<<abstract>>` on the AutoDataBaseAttribute declaration and, if you
need a separate "Core" visual marker, define a CSS class via classDef (e.g.,
classDef Core ...) and attach it to AutoDataBaseAttribute with a class statement
(e.g., class AutoDataBaseAttribute Core) so the diagram shows both the abstract
stereotype and the Core styling separately.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: bc41bbcf-a376-4f9f-856b-2fb90e23a054
📒 Files selected for processing (3)
AGENTS.mdCLAUDE.mdREADME.md
Summary
AGENTS.md— comprehensive project context for all AI coding assistants (Claude Code, GitHub Copilot, OpenAI Codex, Cursor). Covers repository layout, build/test/pack commands, architecture (with Mermaid diagrams), public API, test conventions, coding conventions, CI/CD overview, and AI agent working rules.CLAUDE.md— Claude Code entry point that importsAGENTS.mdand adds the single Claude-specific instruction (plan mode for non-trivial changes).README.md— adds an Installation section withdotnet add packagecommands and a Contributing section pointing toAGENTS.md.Why
AI coding assistants give generic advice without project context. These files allow them to give convention-aware, accurate assistance from the first message of any session — without re-exploring the repository each time.
AGENTS.mdis the single source of truth.CLAUDE.mdimports it rather than duplicating content. GitHub Copilot readsAGENTS.mddirectly (no separate instructions file needed as of the current Copilot documentation).Test plan
CLAUDE.md@AGENTS.mdimport resolves in Claude Codedotnet add packagecommands in README match published package names🤖 Generated with Claude Code
Summary by CodeRabbit
dotnet add packagecommands for each supported mocking framework variant