Best Practice Guidelines for AGENTS.md
This special profile is the AI equivalent of a 'project onboarding manual' and is recommended to contain the following core elements:
- test specification: Explicit test commands (e.g.
pytest), coverage requirements and operational pathways - coding style: Define the linter configuration (e.g.
flake8), formatting standards, etc. - Module Description: Label key file paths and their functions, e.g.
src/core/auth.pyHandling authentication logic - Workflow constraints: Specify collaboration requirements such as PR message formats, submission specifications, etc.
Files should be placed in the project root directory or multi-level subdirectories (following the proximity priority principle). Typical cases show that the Codex task one-time pass rate can be increased by more than 60% in projects equipped with perfect AGENTS.md. For complex projects, it is recommended to refer to the examples in the article to establish a hierarchical guidance document.
This answer comes from the articleChatGPT Codex: Intelligence for Automating Software Engineering TasksThe
May not be reproduced without permission:AI productivity tools " How to optimize the working of Codex using the AGENTS.md file?
English 
简体中文 
日本語 
Deutsch 
Português do Brasil