create-agentsmd-instructions
Installation
SKILL.md
Create AGENTS.md Instructions
Create or update AGENTS.md file for the project.
Steps
- Review all following documentations to understand what constitutes a well-crafted
AGENTS.md - Conduct a thorough examination of the codebase to understand the architecture and stylistic conventions.
- Check if
AGENTS.md,.github/copilot-instructions.mdorCLAUDE.mdalready exists. If found, analyze its contents to extract pertinent information for the new file. - Compose a
AGENTS.mddocument 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.
- Create or rewrite the
AGENTS.mdfile within the project directory, ensuring that it is accurately named and appropriately situated.