Skip to content

docs: add AGENTS.md - #56

Open
YvesCesar wants to merge 1 commit into
mainfrom
docs/agents-md
Open

docs: add AGENTS.md#56
YvesCesar wants to merge 1 commit into
mainfrom
docs/agents-md

Conversation

@YvesCesar

Copy link
Copy Markdown

I added this documentation so that AI agents can understand the context of the project.

I haven't done a thorough review yet because I'm still getting my bearings here. I thought it would be more practical to open the PR for you all to review.

Signed-off-by: YvesCesar <yvesamorim73@gmail.com>

@vitormattos vitormattos left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think AGENTS.md is useful here, but some parts seem too tied to the current implementation, with specific classes, methods and internal behavior.

My concern is that this may become outdated quickly after a refactor, or even make the agent treat current architectural limitations as rules that should be preserved.

I would keep AGENTS.md focused on stable operational guidance: project conventions, compatibility requirements, tests, commands and constraints. Implementation details should live in the project documentation, while desired architectural improvements are better tracked as issues.

It would also be useful to explicitly state that AGENTS.md should be updated whenever a valid change makes any of its guidance outdated.

Comment thread CLAUDE.md
@@ -0,0 +1 @@
@AGENTS.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Isn't this file unnecessary?
The AGENTS.md is a pattern

Comment thread AGENTS.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think AGENTS.md is useful here, but some parts seem too tied to the current implementation, with specific classes, methods and internal behavior. My opinion is that this may become outdated quickly after a refactor, or even make the agent treat current architectural limitations as rules that should be preserved.

I would keep AGENTS.md focused on stable operational guidance: project conventions, compatibility requirements, tests patterns, commands or where can found the commands and constraints.

It would also be useful to explicitly state that AGENTS.md should be updated whenever a valid change makes any of its guidance outdated.

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