-
Notifications
You must be signed in to change notification settings - Fork 460
[Docs] Add AGENTS.md file for AI coding agent instructions #4401
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
[Docs] Add AGENTS.md file for AI coding agent instructions #4401
Conversation
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
This PR adds an AGENTS.md file following the agents.md standard to provide structured guidance for AI coding agents working on the Microsoft Fluent UI Blazor components library. The file serves as a dedicated resource containing project context, build instructions, coding standards, and contribution workflows specifically tailored for AI agents.
- Adds comprehensive project setup and build instructions
- Documents code style guidelines, test conventions, and PR requirements
- Provides repository structure overview and contribution workflow guidance
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
I've addressed the review feedback: ✅ Updated Node.js version from 20.15 LTS to 22.x @vnbaaij Regarding your question about keeping dev-v5 as default after the next release - the file is indeed targeting v5 and uses dev-v5 branch references. Let me know if this should be adjusted for future compatibility. |
|
@vnbaaij & @dvoituron I updated this PR 👍 |
📖 Description
This PR adds an
AGENTS.mdfile to the root of the repository following the agents.md standard.What is AGENTS.md?
AGENTS.mdis an open format for guiding AI coding agents, used by over 60k open-source projects. It serves as a README for AI agents - a dedicated, predictable place to provide context and instructions to help AI coding agents work effectively on the project.Purpose
While
README.mdfiles are for humans (quick starts, project descriptions, contribution guidelines),AGENTS.mdcomplements this by containing the extra context AI coding agents need:Compatibility
The
AGENTS.mdformat is compatible with a growing ecosystem of AI coding tools including:👩💻 Reviewer Notes
This is a documentation-only change that adds guidance for AI coding agents working on this repository. No code changes are included.
📑 Test Plan
N/A - Documentation only.
✅ Checklist
General
📚 References