Add agents.md

[gcatanese]

Must wait for #1525

Add AGENTS.md to provide code assistants with the necessary context to help developers:

• setup the library
• configure and initialise the Client object
• generate code snippets
• adopt best practices (i.e. error handling)

[gemini-code-assist]

Summary of Changes

Hello @gcatanese, 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 introduces a new agents.md file, which serves as a dedicated guide for AI-based coding assistants. The purpose of this file is to equip these AI tools with the necessary context and examples to help developers efficiently set up, configure, and utilize the Adyen Java API Library. By providing clear instructions and code snippets for common tasks like client initialization, making payments, handling errors, processing webhooks, and managing idempotency, the PR aims to enhance the developer experience by enabling AI assistants to offer more accurate and relevant support.

Highlights

• New agents.md file added: A new markdown file, agents.md, has been introduced to the repository. This file is specifically designed to provide context and guidance to AI-based coding assistants, such as Copilot or ChatGPT, on how to effectively assist developers using the Adyen Java API Library.
• Guidance for AI Assistants: The agents.md file outlines general rules for AI assistants, including using com.adyen package classes, providing minimal and copy-pasteable examples, using Environment.TEST, and emphasizing the use of environment variables for credentials. It also specifies resources for AI to reference, such as the library's GitHub, API Explorer, and sample applications.
• Comprehensive Code Examples: The new file includes practical code snippets and instructions covering essential aspects of the Adyen Java API Library. This includes installation steps (Maven/Gradle), client setup, making payments with the Checkout API, robust error handling using ApiException, processing webhooks, and implementing idempotency keys for reliable API calls.
• Adyen API Library Overview: The document provides a concise overview of the Adyen Java API Library, detailing its purpose as a client SDK for integrating with Adyen from Java applications. It highlights features like simplified API access, request/response models, security helpers, and error handling utilities, along with a list of supported Adyen APIs (e.g., Checkout, Terminal API, Management API, Webhooks).

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

This pull request introduces an agents.md file to guide AI assistants in generating code for the Adyen Java API library. This is a valuable addition for improving the developer experience. However, several of the code examples contain syntax errors, incorrect API usage, and other issues that would prevent them from working as-is. I've provided detailed comments and suggestions to correct these problems, ensuring the examples are accurate, functional, and follow best practices.