GitHub Copilot Instructions
Defines coding standards, architecture rules, PR expectations, and output format for a Laravel + Inertia + Vue 3 project.
What this file does
Defines coding standards, architecture rules, PR expectations, and output format for a Laravel + Inertia + Vue 3 project.
When to use it
- Onboarding new developers to a Laravel + Inertia + Vue 3 codebase
- Setting up GitHub Copilot instructions for a team project
- Enforcing consistent code style and architecture across a monorepo
- Automating PR review guidelines for a Laravel application
Assumes this stack
GitHub Copilot Instructions
Coding Standards
- Follow Laravel best practices (service classes, form requests, named routes, tests in Pest).
- Use Inertia + Vue 3 composition API.
- Use shadcn-vue components.
- Use TypeScript on frontend.
- Use Eloquent API Resources and Laravel Actions pattern where appropriate.
- Prefer
$this->postJson()and$this->getJson()in tests.
Architecture Rules
- Keep controllers thin.
- Move business logic to Services/Actions.
- Keep Vue components small and composable.
- Use Wayfinder for route generation.
- Use Spatie Query Builder for filtering endpoints.
PR Expectations
- Include explanation, implementation details, tests, edge cases, migration notes.
- Ensure 90%+ test coverage for new changes.
- Follow semantic commit naming.
Don’ts
- Don’t generate inline CSS.
- Don’t hardcode URLs.
- Don’t use global helpers in Vue — use composables.
- Don’t modify core framework files.
Output Format
- Use clean code.
- Avoid over-engineering.
- Conform to PSR-12, Laravel Pint.
What's inside
5 sections: Coding Standards, Architecture Rules, PR Expectations, Don’ts, Output Format.
Change this for your project
- Replace
Laravel best practiceswith your own framework conventions if not using Laravel - Replace
shadcn-vuewith your component library if different - Replace
Wayfinderwith your route generation tool if not used - Replace
Spatie Query Builderwith your filtering library if different
Where it goes
Keep it in your repository where the agent or team that needs it will read it.
Related Documents
System Prompt
Defines the identity, capabilities, response style, and spec workflow for an AI assistant named Kiro that helps developers build features incrementally.
World Engine AI Coding Instructions
Defines game scope, architecture, ESLint rules, git workflow, and open-source research policy for a strategic fantasy RPG project.
Business Intelligence Dashboard - Comprehensive GitHub Copilot Instructions
Defines the full stack, setup commands, security rules, and testing strategy for a Next.js SaaS analytics platform with multi-tenant isolation.