Skip to content

chore: add AI coding assistant context files - #300

Merged
piotrzajac merged 3 commits into
masterfrom
feature/ai-ready-repository
Apr 7, 2026
Merged

chore: add AI coding assistant context files#300
piotrzajac merged 3 commits into
masterfrom
feature/ai-ready-repository

Conversation

@piotrzajac

@piotrzajac piotrzajac commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds 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.
  • Adds CLAUDE.md — Claude Code entry point that imports AGENTS.md and adds the single Claude-specific instruction (plan mode for non-trivial changes).
  • Updates README.md — adds an Installation section with dotnet add package commands and a Contributing section pointing to AGENTS.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.md is the single source of truth. CLAUDE.md imports it rather than duplicating content. GitHub Copilot reads AGENTS.md directly (no separate instructions file needed as of the current Copilot documentation).

Test plan

  • Verify Mermaid diagrams render correctly on GitHub
  • Verify CLAUDE.md @AGENTS.md import resolves in Claude Code
  • Verify dotnet add package commands in README match published package names

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added installation instructions to README with dotnet add package commands for each supported mocking framework variant
    • Added contributing section with guidance on project architecture, coding conventions, and development guidelines

piotrzajac and others added 3 commits April 7, 2026 17:11
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>
@coderabbitai

coderabbitai Bot commented Apr 7, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Three 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

Cohort / File(s) Summary
New Contributor & Architecture Documentation
AGENTS.md, CLAUDE.md
Comprehensive guide (AGENTS.md) covering project purpose, repository structure, build commands, architectural extension model, public APIs, testing conventions, dependency management, versioning, CI/CD, local setup, and working rules for AI assistants. Claude-specific instructions file (CLAUDE.md) adds tool requirements including plan mode for non-trivial changes.
README.md Updates
README.md
Added "Installation" section with dotnet add package commands for supported mocking frameworks (AutoMoq, AutoNSubstitute, AutoFakeItEasy) and "Contributing" section referencing AGENTS.md for project context and working guidelines.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hop, hop—new docs take flight!
AGENTS guide the way so bright,
CLAUDE calls for plans before the code,
README shows the installation road,
A roadmap written true and kind,
For humans and machines aligned!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: add AI coding assistant context files' accurately and concisely summarizes the main change—adding documentation files (AGENTS.md, CLAUDE.md, and README updates) intended for AI coding assistant context.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/ai-ready-repository

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between b6495c7 and 38dcab2.

📒 Files selected for processing (3)
  • AGENTS.md
  • CLAUDE.md
  • README.md

Comment thread AGENTS.md
@piotrzajac
piotrzajac merged commit d107aa6 into master Apr 7, 2026
1 check passed
@piotrzajac
piotrzajac deleted the feature/ai-ready-repository branch April 7, 2026 21:18
@coderabbitai coderabbitai Bot mentioned this pull request Apr 17, 2026
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant