Instruction file imported from renchey/work-context-system (
.github/instructions/agent.instructions.md). Copyright stays with the author.
Analyze this codebase to generate or update .github/copilot-instructions.md for guiding AI coding agents.
Focus on discovering the essential knowledge that would help AI agents be immediately productive in this codebase. Consider aspects like:
- The "big picture" architecture that requires reading multiple files to understand - major components, service boundaries, data flows, and the "why" behind structural decisions
- Critical developer workflows (builds, tests, debugging) especially commands that aren't obvious from file inspection alone
- Project-specific conventions and patterns that differ from common practices
- Integration points, external dependencies, and cross-component communication patterns
Source existing AI conventions from **/{.github/copilot-instructions.md,AGENT.md,AGENTS.md,CLAUDE.md,.cursorrules,.windsurfrules,.clinerules,.cursor/rules/**,.windsurf/rules/**,.clinerules/**,README.md} (do one glob search).
Guidelines (read more at https://aka.ms/vscode-instructions-docs):
- If
.github/copilot-instructions.mdexists, merge intelligently - preserve valuable content while updating outdated sections - Write concise, actionable instructions (~20-50 lines) using markdown structure
- Include specific examples from the codebase when describing patterns
- Avoid generic advice ("write tests", "handle errors") - focus on THIS project's specific approaches
- Document only discoverable patterns, not aspirational practices
- Reference key files/directories that exemplify important patterns
Hygiene Rules
-
Use markdown formatting (headings, code blocks, lists) for clarity
-
Keep instructions focused on actionable knowledge for AI agents
-
Avoid redundancy; consolidate similar instructions
-
Ensure accuracy; verify instructions against the current codebase
- Use Prettier for code layout and formatting
- Use markdownlint for markdown linting
- Use CSpell for spell checking (en-GB dictionary, except for code snippets)
Generated .github/copilot-instructions.md
Update .github/copilot-instructions.md for the user, then ask for feedback on any unclear or incomplete sections to iterate.