Skip to content
vibespell

.github/copilot-instructions.md

Copilot instructions for Laravel

GitHub Copilot reads `.github/copilot-instructions.md` and applies it across the repository. It is the place for build commands, review rules, and stack conventions Copilot should not invent. This copy is written for a Laravel project. This repository is a Laravel application. Routes stay thin, Eloquent owns persistence, and schema changes go through migrations. Use Artisan for the commands the repo already expects.

The example uses a balanced, readable style, pragmatic tests, and comments only where the intent is not obvious. Open the generator to make the agent stricter, switch to test-first, quiet the comments, or pick a different file.

The example assumes Laravel with Eloquent and migrations. It does not assume Inertia, Livewire, or a particular admin package. If the repo uses one of those, follow it instead of adding a second UI stack.

Example file

Balanced strictness, readable style, pragmatic tests. Download name: copilot-instructions.md

# GitHub Copilot instructions

These instructions apply to the whole Laravel repository. Copilot reads them from `.github/copilot-instructions.md`.
Prefer the commands and layout below over guesses.

## Stack

This repository is a Laravel application. Routes stay thin, Eloquent owns persistence, and schema changes go through migrations. Use Artisan for the commands the repo already expects.

## Layout

- HTTP entry points live in routes and controllers. Non-trivial rules live in actions, models, or domain classes.
- Form requests validate input. Policies and gates authorize it.
- Database changes ship as migrations. Do not edit a migration that has already run in production.

## Commands

- Dev server: `php artisan serve`
- Tests: `php artisan test`
- Migrate: `php artisan migrate`

Use the script the repo already defines when it differs from the command above.

## Conventions

- Use Eloquent and query scopes. Reach for the query builder only when the ORM cannot say it.
- Validate with a Form Request. Do not read `$request->all()` and hope.
- Authorize with a policy or gate in the same change as the route.
- Queue slow work. Do not send mail or call a third party inside the request if the project already uses jobs.
- Match Pest or PHPUnit, whichever the repo already uses.
- Keep secrets in `.env`. Do not commit `.env` or dump config with secrets into git.

## Testing

Add or update tests when behavior changes.

Cover the Form Request or the action with the repo's Pest or PHPUnit suite. Include one rejection and one success.

## Style

- Optimize for the next reader over the shortest diff.
- Comment only when the why is non-obvious.
- Name things the way neighboring files already do.
- Do not reformat code you did not change.

## Errors

- Fail at the boundary. Do not swallow errors.
- Throw or return a validation error for bad input. Let unexpected exceptions hit the project's exception handler.

## Scope

- Do the requested task. Do not refactor unrelated code.
- Match the rigor already in the repo. Fix what you touch.
- Ask one clarifying question only when the task cannot be finished without it. Otherwise state the assumption and continue.

## Avoid

- Do not call `env()` outside config files. Use `config()` after the config is cached.
- Do not hide N+1 queries. Eager load relations the response actually walks.
- Do not skip authorization because the route is behind `auth`.
- Do not rewrite a vendor class. Use a container binding or an event the framework already fires.

## Done when

- The requested behavior works.
- `php artisan test` passes, and a new migration is included when the schema changed.
- The diff stays inside the task.
- You list anything you could not run.

## Review checklist

- The change matches the commands and layout in this file.
- No new dependency was added without a reason already present in the repo.
- Leave CSRF protection on for web routes.
- Mass-assign only through `$fillable` or `$guarded` the model already uses.
- Do not log request bodies that contain passwords or tokens.

Add it to the project

  1. 01

    Copy a starting file

    Copy the example Copilot instructions on this page, or open the generator if you want different testing, strictness, or comment rules.

  2. 02

    Save it at .github/copilot-instructions.md

    Save it as `.github/copilot-instructions.md` in the Laravel repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.

  3. 03

    Start a fresh agent session

    Rules files are read when a session starts. A chat that is already open may still be using the old instructions.

  4. 04

    Give it one small task

    Ask for one change a Laravel agent often gets wrong, such as a form request that rejects a bad payload before the controller runs. If it ignores the file, confirm the path and start a new session.

Questions about this file

Where do I put Copilot instructions in a Laravel repo?

Save it as `.github/copilot-instructions.md` in the Laravel repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.

Which tools read this Copilot instructions?

GitHub Copilot in VS Code, Visual Studio, and Copilot cloud agents read this file. Other agents will not load it automatically, so keep an AGENTS.md too if more than one tool edits the repo.

What does the Laravel example assume?

The example assumes Laravel with Eloquent and migrations. It does not assume Inertia, Livewire, or a particular admin package. If the repo uses one of those, follow it instead of adding a second UI stack.

Does VibeSpell upload my repository?

No. Recipe pages are static, and the generator builds the file in your browser from the options you pick. Your source code never leaves the machine.

Other files for Laravel

Copilot instructions for other stacks