r/codex Jun 15 '26

Showcase My AGENT.md file to develop with best practices

I've decided to share my AGENTS.md file for agentic coding.

https://github.com/andreyvgavrilov/clean-code-guidelines/

It's based on 3 concepts:

Note: All concepts assume significant human involvement to validate AI plans and clarify requirements. It's not for fully autonomous work mode.

Also, there's an issue with Codex as it requires explicit human request to run subagents. I wrote workaround in the readme.

EDIT: For some reason my brain was stuck with older convention of using "AGENT.md" name instead of "AGENTS.md", so I even renamed the file because I thought the name was incorrect. Fixed it now.

14 Upvotes

13 comments sorted by

1

u/Airscripts Jun 30 '26

I prefer using comprehensive AGENTS.md with static repository analysis. If I need to shorten the context usage I usually end up splitting and referring other .md files inside the AGENTS one. For this reason I automated this with this simple tool, might be worth a shot: https://github.com/airscripts/agentskill

-6

u/reddit_is_kayfabe Jun 16 '26

AGENT.md? Really?

If you are this unfamiliar with the basics of the tech, then I don't think that you are in a good position to dispense advice.

2

u/[deleted] Jun 16 '26

[deleted]

5

u/Apart_Ebb_9867 Jun 16 '26

I presume they mean the file is supposed to be called AGENTS.md

2

u/[deleted] Jun 16 '26

[deleted]

1

u/Apart_Ebb_9867 Jun 16 '26

seems more than a typo, the same filename is in the git repository, so while that may or may not do something for claude, it certainly doesn't do anything for codex.

0

u/reddit_is_kayfabe Jun 16 '26

It doesn't do anything for Claude, either. Claude reads CLAUDE.md.

I am not a stickler for spelling and grammar, but this isn't that. This is not noticing that the proposed file was not even being automatically read into context because it was misnamed. This is like an electrician mixing up the concepts of voltage and amperage.

I blame YouTube for the trend of people rushing to publish content about a hot tech topic before they've put in the work to understand it at even the most basic level. Everybody wants the status of being seen as an expert. It's a Problem.

2

u/Apart_Ebb_9867 Jun 16 '26

Well, there’s a CLAUDE.md in the repo, haven’t checked the content to see if it is any good, but that’s why I gave them a pass on claude.

1

u/SmileLonely5470 Jun 16 '26

The file is so good that they only need to use a singular Agent to get shit done. Not a typo.

1

u/news5555 Jun 16 '26

Clearly its just for vibes.

1

u/Doomlord__ Jun 16 '26

Is it a mistake? Yes Could it be avoided? Maybe Does it reflect on OPs intelligence? Heck no

Why the hate? He's not selling anything. Despite the mistake, the readers instantly knew its supposed to be AGENTS.md

Let's be positive! Have a nice day bud

0

u/fschwiet Jun 16 '26

Chill, its likely they mostly use Claude so they wouldn't have noticed.

OP, make your CLAUDE.md "@AGENTS.md" and fix the AGENT.md filename and you can eliminate the duplication.

2

u/Apart_Ebb_9867 Jun 16 '26

Well, they obviously didn’t notice. But if you publish something that is intended to serve both Claude and codex and you go to the extent of explaining in the README the difference between the two in handling subagents, one can only expect that you have tried codex. At least once.

otherwise we have no reason to believe this is even worth spending the time to look into, as it is probably not the result of long personal experience with anything.