Skip to content

Conversation

priethor
Copy link
Contributor

What?

This PR adds an AGENTS.md file with instructions to help AI agents work with this repository.

Why?

AI agents are becoming increasingly popular as a supporting development tool. Rather than ignoring this fact, providing guidelines for AI agents will help them be more effective, resulting in a better and faster developer experience with reduced cost and environmental impact.

How?

By following the AGENTS.md format supported by many agents. It's not a formal spec, but a de facto standard, which focuses on:

  • Give agents a clear, predictable place for instructions.
  • Keep READMEs concise and focused on human contributors.
  • Provide precise, agent-focused guidance that complements existing README and docs.

This first iteration includes dev environment tips, testing instructions, and PR instructions.

Testing Instructions

  1. Run your favorite AI agent and ask it to lint or run tests, which is something they usually don't get right on the first try

@priethor priethor self-assigned this Sep 21, 2025
@priethor priethor added the documentation Improvements or additions to documentation label Sep 21, 2025
Copy link
Contributor

@cbravobernal cbravobernal left a comment

Choose a reason for hiding this comment

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

LGTM

@cbravobernal cbravobernal merged commit 22df7c6 into trunk Sep 23, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants