Skip to content

AGENTS.md for contributors#337

Merged
galesky-a merged 2 commits intomainfrom
add-agents-md
Dec 30, 2025
Merged

AGENTS.md for contributors#337
galesky-a merged 2 commits intomainfrom
add-agents-md

Conversation

@galesky-a
Copy link
Copy Markdown
Contributor

Description
Add an AGENTS.md for contributors.

Tested scenarios
Tested on a couple coding agents by delegating a task before and after adding the files

@galesky-a galesky-a requested review from a team as code owners December 30, 2025 11:58
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @galesky-a, 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, significantly enhancing the documentation for contributors to the Adyen Ruby API Library. The added guide provides essential information on the library's architecture, its code generation mechanisms, development workflow, and automated release procedures, aiming to streamline the onboarding and contribution process for developers.

Highlights

  • New Contributor Guide: Introduced AGENTS.md to serve as a comprehensive guide for contributors to the Adyen Ruby API Library.
  • Code Generation Details: Documented the process of code generation, including the tools used (OpenAPI Generator, Mustache templates), the centralized automation repository (adyen-sdk-automation), and steps for local code generation.
  • Core Components Explained: Provided an overview of the library's core components, such as Adyen::Client, Adyen::Service, and the structure of generated service classes.
  • Development Workflow: Outlined the setup process and how to run tests using bundle install and rspec.
  • Automated Release Process: Detailed the automated release workflow, covering the creation of release PRs and the publishing of new gem versions to RubyGems via GitHub Actions.

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

Copy link
Copy Markdown
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 comprehensive guide for contributors, detailing the project's architecture, code generation process, and development workflow. The document is well-structured and informative. My review focuses on enhancing the clarity and correctness of the provided shell commands to ensure they align with current best practices and are easily understandable, especially if consumed by automated agents.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

@galesky-a galesky-a merged commit fd4c6be into main Dec 30, 2025
12 checks passed
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.

2 participants