dev: Introduce initial AGENTS.md

[vorburger]

Intentionally named AGENTS.md instead of e.g. GEMINI.md to be fully model neutral; see https://agents.md for background.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 establishes a foundational documentation file, AGENTS.md, intended to centralize information concerning agents. The deliberate choice of filename underscores a commitment to model neutrality, ensuring the content remains broadly applicable and avoids bias towards specific implementations. This addition provides an initial point of reference for anyone working with or learning about agents within the project.

Highlights

• New Documentation File: Introduced a new documentation file named AGENTS.md to provide information related to agents.
• Model Neutrality: The file was intentionally named AGENTS.md to ensure model neutrality, referencing https://agents.md for background.
• Validation Instructions: Included a note in the new file instructing users to validate changes by running ./mvnw install.

🧠 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
  • Initial creation of the AGENTS.md file.
  • Added a header # AGENTS.md.
  • Included instructions to validate changes by running ./mvnw install.

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. ↩

[gemini-code-assist]

Code Review

The addition of AGENTS.md is a good initiative for providing model-neutral documentation. However, the current content is very minimal and includes a potentially misleading validation instruction. Clarifying the purpose of this file and providing relevant validation guidance would enhance its utility.