Skip to content

docs: add AGENTS.md with AI coding guidelines#166

Merged
arekay-nv merged 2 commits intomainfrom
docs/agents-md-guidelines
Mar 12, 2026
Merged

docs: add AGENTS.md with AI coding guidelines#166
arekay-nv merged 2 commits intomainfrom
docs/agents-md-guidelines

Conversation

@nvzhihanj
Copy link
Copy Markdown
Collaborator

Summary

  • Restructure CLAUDE.md to contain only @AGENTS.md include directive
  • Create AGENTS.md with comprehensive, tool-agnostic repo guidelines for AI coding agents
  • Add policy requiring AGENTS.md updates alongside significant refactors (with reviewer checklist)
  • Add catalog of common AI coding pitfalls specific to this codebase (serialization, multi-process boundary, async patterns, testing conventions, etc.)

Test plan

  • Verify CLAUDE.md contains only @AGENTS.md
  • Verify AGENTS.md code organization tree matches actual repo structure
  • Verify pre-commit passes (pre-commit run --all-files)

🤖 Generated with Claude Code

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>
@nvzhihanj nvzhihanj requested a review from a team as a code owner March 12, 2026 01:00
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 12, 2026

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@github-actions github-actions bot requested a review from arekay-nv March 12, 2026 01:00
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, 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

  • Documentation Restructuring: CLAUDE.md was restructured to solely include the new AGENTS.md directive, centralizing AI coding guidelines.
  • New AI Coding Guidelines: A new AGENTS.md file was created, providing comprehensive, tool-agnostic guidelines for AI coding agents working within the repository.
  • Guideline Maintenance Policy: A policy was introduced requiring AGENTS.md to be updated concurrently with significant refactors, supported by a reviewer checklist.
  • AI Coding Pitfalls Catalog: A catalog of common AI coding pitfalls specific to this codebase was added, covering areas like serialization, multi-process boundaries, async patterns, and testing conventions.

🧠 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
  • AGENTS.md
    • Added a new file containing comprehensive guidelines for AI coding agents.
    • Included sections on project overview, architecture, code organization, development standards, and common pitfalls.
    • Established a policy for keeping the document updated with significant refactors.
  • CLAUDE.md
    • Updated to include a single directive referencing AGENTS.md.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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>
@arekay-nv arekay-nv merged commit 336e5be into main Mar 12, 2026
4 checks passed
@arekay-nv arekay-nv deleted the docs/agents-md-guidelines branch March 12, 2026 04:20
@github-actions github-actions bot locked and limited conversation to collaborators Mar 12, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants