Skip to content

Conversation

@SAN-MUYUN
Copy link
Contributor

Add Agents.md, an instruction file meant for all AI agents to quickly understand the repo structure and provide suggestions for code changes of a higher quality, following the conventions of the current code base.

Copy link
Collaborator

@jovnc jovnc left a comment

Choose a reason for hiding this comment

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

Some nits but other than that LGTM, feel free to merge or update if you think it is ok

@@ -0,0 +1,97 @@
# AGENTS.md

You are an expert software developer handling this repo.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This doesn't seem to follow AGENTS.md best practices, but I'm ok to keep it if it does improve output

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmmm I think there are different ways of doing this? I took reference from this article

I can change it if you prefer to standardise across the repos and follow the example given :D

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it's ok to keep it as well, feel free to merge it!

You are an expert software developer handling this repo.

## Persona
- You understand the codebase and are capable of explaining the functionality of different components of the repo.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Similarly, we shouldn't be setting persona in AGENTS.md, can refer to examples of AGENTS.md

@SAN-MUYUN SAN-MUYUN merged commit 35fb30e into git-mastery:main Feb 1, 2026
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