Skip to content

chore: add AGENTS.md#375

Open
strantalis wants to merge 1 commit intomainfrom
agents-md
Open

chore: add AGENTS.md#375
strantalis wants to merge 1 commit intomainfrom
agents-md

Conversation

@strantalis
Copy link
Member

No description provided.

@strantalis strantalis requested review from a team as code owners January 13, 2026 16:47
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @strantalis, 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 introduces a new AGENTS.md file, serving as a central repository for essential development and contribution guidelines. Its purpose is to streamline the onboarding process for new contributors and provide a clear reference for existing team members on project structure, testing procedures, coding standards, and PR submission requirements. This addition aims to improve consistency and efficiency across the development workflow.

Highlights

  • New Documentation File: Introduced a new AGENTS.md file to centralize repository guidelines and development information.
  • Comprehensive Guidelines: The new file covers project structure, module organization, build/test/development commands, coding style, testing guidelines, and commit/pull request conventions.
  • Development Workflow: Detailed instructions are provided for setting up the development environment, running xtest with pytest, building SDK CLIs, and executing vulnerability tests.
  • Contribution Standards: The document outlines requirements for semantic commit/PR titles, DCO sign-off, and expectations for PR descriptions and reviewer engagement.

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

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.

@sonarqubecloud
Copy link

Copy link
Contributor

@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 an AGENTS.md file, which serves as a repository guideline for developers. The document is well-structured and covers key areas like project structure, development commands, coding style, and contribution guidelines. My review focuses on improving the clarity and efficiency of the local development workflow described in the document. I've suggested changes to the dependency installation and local testing commands to make them more efficient by avoiding redundant installation steps. Overall, this is a valuable addition to the project's documentation.

## Build, Test, and Development Commands

- Enter the dev environment: `devbox shell` (installs Python/JDK/Node per `devbox.json`).
- Install xtest deps: `python -m pip install -r xtest/requirements.txt`
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To improve the local development workflow, consider including the linting and type-checking tools in this installation step. This avoids reinstalling them every time the checks are run (as per the command on line 27) and centralizes dependency management.

Suggested change
- Install xtest deps: `python -m pip install -r xtest/requirements.txt`
- Install xtest deps & tools: `python -m pip install -r xtest/requirements.txt ruff black pyright`

- `ruff check`
- `black --check .`
- `pyright`
- Local equivalent: `cd xtest && python -m pip install -r requirements.txt && python -m pip install ruff black pyright && ruff check && black --check . && pyright`
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

If the linting tools are installed as part of the main dependency setup (as suggested for line 13), this command can be simplified to only run the checks. This makes the local check process faster and the command easier to read.

Suggested change
- Local equivalent: `cd xtest && python -m pip install -r requirements.txt && python -m pip install ruff black pyright && ruff check && black --check . && pyright`
- Local equivalent: `cd xtest && ruff check && black --check . && pyright`

@github-actions
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant