Add AGENTS.md file for guiding LLM agents - #1375
Conversation
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 676361ae8c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ccfaf5852c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Description
The world has shifted and (outside) PRs without LLMs become increasingly rare. Code produced by LLMs range quite a bit depending on the level of guidance that are given. So far, my experience was that code can actually be of high(er) quality, given the correct instructions.
To ensure that future PRs created by LLMs at least somewhat comply to the projects coding convention I have started to create an
AGENTS.mdfile so that there is some guidance and hopefully lowers the amount of review needed for LLM based PRs. That been said, this file is far from being perfect, but should give some instructions how the code should look like. To be improved in the future.Feel free to leave feedback
This file was created by codex with
gpt-5.6-sol highwhile working on the shadow-creds module (#1368).Type of change
Insert an "x" inside the brackets for relevant items (do not delete options)
Setup guide for the review
N/A
Screenshots (if appropriate):
N/A
Checklist:
Insert an "x" inside the brackets for completed and relevant items (do not delete options)
poetry run ruff check ., use--fixto automatically fix what it can)tests/e2e_commands.txtfile if necessary (new modules or features are required to be added to the e2e tests)