.github/copilot-instructions.md
Copilot instructions for Bevy
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 Bevy project. This repository is a Bevy game. Data lives in components, behavior lives in systems, and schedules stay explicit. Do not reach for a God object.
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 Bevy. It does not assume a particular physics crate or UI crate unless Cargo.toml already depends on it.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: copilot-instructions.md
# GitHub Copilot instructions
These instructions apply to the whole Bevy repository. Copilot reads them from `.github/copilot-instructions.md`.
Prefer the commands and layout below over guesses.
## Stack
This repository is a Bevy game. Data lives in components, behavior lives in systems, and schedules stay explicit. Do not reach for a God object.
## Layout
- Plugins group related systems. The app binary adds plugins. It does not contain the rules.
- Components are plain data. Systems are functions.
- Assets use the project's asset path and handles, not filesystem reads scattered through systems.
## Commands
- Run: `cargo run`
- Test: `cargo test`
- Check: `cargo clippy --all-targets -- -D warnings`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Query the smallest component set that proves the rule.
- Use commands to spawn and despawn. Do not mutate the world unsafely.
- Exclusive systems are rare. Prefer a normal system with the right system param.
- Put one-shot work in `OnEnter` or an event. Do not gate it with a boolean checked every frame.
- Do not `unwrap` on a missing asset handle.
- Run `cargo fmt` and clippy on gameplay changes.
## Testing
Add or update tests when behavior changes.
Test a pure system with a minimal App or a plain function. Do not boot the full game.
## 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.
- Log a missing asset and skip the spawn. A missing optional component is absence, not a panic.
## 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 store an Entity and assume it still exists next frame without a check.
- Do not allocate a new collection inside a hot system every frame.
- Do not use thread-local hacks to smuggle state. Use a resource.
- Do not add a second ECS mindset. Bevy's world is the world.
## Done when
- The requested behavior works.
- `cargo test` passes and `cargo clippy --all-targets -- -D warnings` is clean for non-trivial changes.
- 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.
- Do not trust network payloads as components without validation.
- Keep tokens out of the client binary.
- Do not use unsafe to skip a bounds check on player-controlled input.
Add it to the project
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.
02
Save it at .github/copilot-instructions.md
Save it as `.github/copilot-instructions.md` in the Bevy repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.
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.
04
Give it one small task
Ask for one change a Bevy agent often gets wrong, such as a system that queries the components it needs and does not spawn entities every frame by accident. 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 Bevy repo?
Save it as `.github/copilot-instructions.md` in the Bevy 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 Bevy example assume?
The example assumes Bevy. It does not assume a particular physics crate or UI crate unless Cargo.toml already depends on it.
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 Bevy
Copilot instructions for other stacks
- Copilot instructions for Next.js
- Copilot instructions for React
- Copilot instructions for Vue
- Copilot instructions for SvelteKit
- Copilot instructions for Node.js
- Copilot instructions for FastAPI
- Copilot instructions for Django
- Copilot instructions for Go
- Copilot instructions for Rust
- Copilot instructions for Unity
- Copilot instructions for Godot
- Copilot instructions for Laravel
- Copilot instructions for Rails
- Copilot instructions for Flutter
- Copilot instructions for Swift
- Copilot instructions for Kotlin
- Copilot instructions for Unreal
- Copilot instructions for Next.js + Supabase
- Copilot instructions for T3
- Copilot instructions for Astro
- Copilot instructions for Remix
- Copilot instructions for Nuxt
- Copilot instructions for Electron
- Copilot instructions for Tauri
- Copilot instructions for Expo
- Copilot instructions for Spring Boot
- Copilot instructions for .NET
- Copilot instructions for Phaser
- Copilot instructions for Roblox
- Copilot instructions for Python ML
- Copilot instructions for LangChain