-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: Add CLAUDE.md for AI assistant guidance #3749
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Add comprehensive documentation for AI assistants working on this codebase: - Architecture overview with directory structure and design patterns - Development commands for Python (uv/poe) and .NET (dotnet) - Code conventions, linting rules, and preferred libraries - CI/CD workflow reference - Known TODOs and quick start guide
|
@wolram please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
wolram
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds a repository-root CLAUDE.md intended to guide AI assistants contributing to the Agent Framework repo, summarizing architecture, dev commands, conventions, CI workflows, and contributor quick start.
Changes:
- Introduces an AI-assistant guide covering repo structure and core design patterns.
- Documents Python (
uv/poe) and .NET (dotnet) development workflows and quality gates. - Adds quick-reference tables for conventions, preferred libraries, and CI workflows.
| │ │ ├── Microsoft.Agents.AI.Workflows/ | ||
| │ │ ├── Microsoft.Agents.AI.Workflows.Declarative/ | ||
| │ │ ├── Microsoft.Agents.AI.A2A/ | ||
| │ │ └── Microsoft.Agents.AI.Hosting*/ |
Copilot
AI
Feb 8, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The directory listing includes Microsoft.Agents.AI.Hosting*/ with a literal *, which looks like an unintended wildcard and doesn’t match an actual path. Consider listing the concrete Microsoft.Agents.AI.Hosting/ directories (e.g., Microsoft.Agents.AI.Hosting/, Microsoft.Agents.AI.Hosting.A2A/, etc.) or remove the * to avoid confusion.
| │ │ └── Microsoft.Agents.AI.Hosting*/ | |
| │ │ └── Microsoft.Agents.AI.Hosting/ |
|
|
||
| --- | ||
|
|
||
| ## Known TODOs (101 total) |
Copilot
AI
Feb 8, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
“Known TODOs (101 total)” is a hard-coded count that will drift as TODOs are added/removed and can quickly become inaccurate. Prefer removing the exact number (or replace with a command/link to generate the count) so this section stays evergreen.
| ## Known TODOs (101 total) | |
| ## Known TODOs |
| ### Key ADRs (docs/decisions/) | ||
| | ADR | Topic | | ||
| |-----|-------| | ||
| | 0001 | Agent Run Response Pattern | | ||
| | 0002 | Agent Tools/Functions | | ||
| | 0003 | OpenTelemetry Instrumentation | | ||
| | 0006 | User Approval Workflows | | ||
| | 0007 | Filtering Middleware | | ||
|
|
Copilot
AI
Feb 8, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown tables are written with a double leading pipe (e.g., || ADR | Topic |), which renders as an extra empty first column in standard Markdown. Use a single leading | for each row (and update the other tables in this doc that follow the same pattern).
|
@wolram thanks for this, but we have already setup a bunch of AGENTS.md and wish to use that more generic name, rather then a claude specific one, it is also two projects side by side and not just a dotnet one, so dotnet specific instructions should be in the dotnet folder. |
Add comprehensive documentation for AI assistants working on this codebase:
Motivation and Context
Description
Contribution Checklist