-
-
Notifications
You must be signed in to change notification settings - Fork 419
Add Agents.md instruction for AI-assisted coding #1344
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
The "Agents" instruction file seems very unstandardized to me. https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions "# AGENTS.md spec" I like the idea, but this seems like not just one MORE file that will need to be kept up to date when the code changes, but possibly 6 or more depending on what other bot(s) we want to support. :/ |
|
I asked Codex to generate an agents.md and this is what it came up with: Not impressed. May need to come up with a more thorough prompt. So meta to ask ChatGPT to generate a prompt for Codex! :) |
|
Agents.md files are used by the Codex container. One big problem with the agents file in this pr is that it instructs about macOS, but I highly doubt the container itself runs as macOS; it is most likely Linux. So the agents file will need to assert Linux. But Linux is our smallest install so instructing AI for Linux does not give us as big of an impact as it would if we could assert Windows or macOS... Which I don't know if we can yet. Another opinion I have is that the natural language agents.md file in this PR seems to be written to be more beneficial to a human than a bot. I don't know if a bot really cares too much about a detailed description of the code structure. Maybe it does, but this seems more beneficial to a human than a bot that has a limited token set. I'd think that it might be better to use those tokens on more useful bot instructions than a verbose prose about the directory structure. |
|
Here is my asking ChatGPT 5 to generate a prompt to ask Codex to generate an agents.md: And then my Codex session that uses that prompt: Better, but still feels lacking. I might still want to focus on Linux only workflow, since that is the only container platform I know Codex supports. |
|
I think the most likely Windows or macOS possibility would be to run the codex CLI locally on those platforms: |
|
My understanding of the agents.md is to not have to rely on "every-flavor-of-the-week" AI-agents and centralise it all in one "file" for instruction. I use it across a bunch of Claude / Gemini / openAi and self-hosted LLM. The version in this PR is more detailed / talkative than my initial draft. I am 100% ok for reducing it and using more bullet-point that sentences (might help in maintaining it). This was AI-generated + manually checked / tweaked by myself ( it always wanted to go back to the MacOS specifics build and hallucinated the purpose of the CI/ folder) What would be nice is :
@paulpv as part of the active devs, i think you are the main one using codex. (I don't for this project). |
As AI-assisted code tools are everywhere, this PR tries to provides an agents.md file to be provided to the AI-Agent.
ALL code submitted must be able to be explained for the choices made, we do not forbide AI-assisted codeing but whatever the results are, they must be human-verified.
This PR is here for discussion toward a first commit that should continue to be improved.