create-copilot-instructions
Installation
SKILL.md
Create Copilot Instructions
Create or update AGENTS.md file for the project.
Steps
-
Review the documentation at https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot to understand what constitutes a well-crafted
AGENTS.mdorcopilot-instructions.md. -
Conduct a thorough examination of the codebase to understand the architecture and stylistic conventions.
-
Check if
AGENTS.mdor.github/copilot-instructions.mdalready exists..github/copilot-instructions.mdtakes precedence overAGENTS.md. 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.