docs: add AGENTS.md with AI coding guidelines#166
Conversation
Move repo guidelines from CLAUDE.md into AGENTS.md so they are tool-agnostic and usable by any AI coding agent. CLAUDE.md now contains only an @AGENTS.md include directive. AGENTS.md covers architecture, code organization, development standards, and adds two new sections: a policy requiring AGENTS.md updates alongside significant refactors, and a catalog of common AI coding pitfalls specific to this codebase. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the repository's documentation for AI coding agents by introducing a dedicated and comprehensive AGENTS.md file. This new guide centralizes project information, architectural details, development standards, and a crucial list of common AI coding pitfalls, ensuring that AI-assisted development aligns with the codebase's specific conventions and performance requirements. The change also includes a mechanism to keep this documentation up-to-date with future refactors. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive AGENTS.md file to guide AI coding agents, which is a great initiative for improving AI-assisted development in this repository. The document is well-structured and covers many important aspects of the codebase. I've found a couple of minor inconsistencies in the documentation that could be improved for clarity and accuracy.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
CLAUDE.mdto contain only@AGENTS.mdinclude directiveAGENTS.mdwith comprehensive, tool-agnostic repo guidelines for AI coding agentsAGENTS.mdupdates alongside significant refactors (with reviewer checklist)Test plan
CLAUDE.mdcontains only@AGENTS.mdAGENTS.mdcode organization tree matches actual repo structurepre-commit run --all-files)🤖 Generated with Claude Code