.github/copilot-instructions.md
# GitHub Copilot Instructions Use this file to guide GitHub Copilot in this repository. ## Project Context - Project type: Next.js - Tech stack: Next.js, TypeScript, React, CSS modules - Coding style: Prefer small components, explicit types, accessible UI, and existing project patterns. - AI tool target: Copilot Instructions ## Project Commands - Package manager: npm - Test: `npm test` - Build: `npm run build` - Lint: `npm run lint` ## Working Agreement - Read nearby files and reuse established project patterns. - Make small, reviewable changes. - Do not introduce new dependencies unless they clearly reduce complexity. - Keep user-facing text concise and accessible. - Preserve unrelated user changes in the working tree. ## Validation 1. Run `npm run lint` for style and static checks. 2. Run `npm test` for behavior. 3. Run `npm run build` before release or handoff. ## Extra Instructions Before handoff, summarize changed files and mention any checks that could not be run.
Use the Copilot Instructions generator to create .github/copilot-instructions.md for repository-specific GitHub Copilot guidance. This helps Copilot follow your architecture, commands, and review expectations.
What To Put In Copilot Instructions
Include stable conventions such as project layout, coding style, test commands, accessibility expectations, and areas where Copilot should reuse existing helpers instead of inventing new abstractions.
Team Rollout
Commit the file when the guidance is shared by the team. Review it during architecture changes so Copilot does not keep following outdated assumptions.
FAQ
Where does the file live?
The common location is .github/copilot-instructions.md in the repository.
Should it duplicate the README?
No. Keep it focused on AI coding behavior, commands, and project-specific constraints.