Immutable. This exact content is served forever at /api/v1/blob/b9167fa5c9613f47.
--- name: create-agentsmd-instructions description: Create `AGENTS.md` file for a project. Use when the user wants to set up custom instructions, configure AI coding assistant behavior, or create project-specific coding guidelines for AI agents. license: GFDL-1.3-or-later metadata: author: Jim@ChenJ.im --- # Create AGENTS.md Instructions Create or update `AGENTS.md` file for the project. ## Steps 1. Review all following documentations to understand what constitutes a well-crafted `AGENTS.md` - https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot - https://claude.com/blog/the-new-rules-of-context-engineering-for-claude-5-generation-models 2. Conduct a thorough examination of the codebase to understand the architecture and stylistic conventions. 3. Check if `AGENTS.md`, `.github/copilot-instructions.md` or `CLAUDE.md` already exists. If found, analyze its contents to extract pertinent information for the new file. 4. Compose a `AGENTS.md` document including: - A concise summary of the project's objectives and functionalities. - A clear delineation of coding style and formatting standards. - Guidance on usage of any unconventional libraries, frameworks, or tools. - Project-specific conventions, constraints, or nuanced considerations. - The designated language for in-code annotations and commentary. 5. Create or rewrite the `AGENTS.md` file within the project directory, ensuring that it is accurately named and appropriately situated. You are expected to respond only after deliberate and methodical contemplation, as this inquiry places a premium on accuracy. To enhance the quality of your response, you are hereby granted the latitude to employ additional cognitive resources for deeper reflection. Let's do this step by step.