.github/copilot-instructions.md
Copilot instructions for Go
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 Go project. This repository is a Go module. Format with gofmt, keep the standard library first, and pass context through exported I/O.
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 a Go module that gofmt can format. It does not assume a web framework. If the repo uses chi, gin, or the standard net/http, stay with that router.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: copilot-instructions.md
# GitHub Copilot instructions
These instructions apply to the whole Go repository. Copilot reads them from `.github/copilot-instructions.md`.
Prefer the commands and layout below over guesses.
## Stack
This repository is a Go module. Format with gofmt, keep the standard library first, and pass context through exported I/O.
## Layout
- Packages are small and named for what they provide, not `util`.
- `cmd/` holds binaries. Importable code lives in other packages.
- Internal packages stay under `internal/` when the module already uses that boundary.
## Commands
- Test: `go test ./...`
- Format: `gofmt -w .`
- Vet: `go vet ./...`
- Build: `go build ./...`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Run gofmt on every change. Do not hand-align code in a way gofmt will undo.
- Accept interfaces, return concrete types, unless the package already does otherwise.
- Pass `context.Context` as the first argument after the receiver on I/O that can be cancelled.
- Wrap errors with `%w` when the caller should use `errors.Is` or `errors.As`.
- Handle errors where they happen. Do not assign them to `_`.
- Exported names have a doc comment when the package is imported by other modules.
## Testing
Add or update tests when behavior changes.
Prefer table-driven tests in the same package. Cover the success path and one failure.
## 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.
- Return `error`. Wrap it with enough context to know which operation failed. Do not log and return the same error unless the caller cannot see the log.
## 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 panic for a normal error path.
- Do not start a goroutine without a way to finish it.
- Do not share a map across goroutines without synchronization.
- Do not add a framework for a handler the standard library already serves.
## Done when
- The requested behavior works.
- `gofmt` leaves the tree clean and `go test ./...` passes.
- 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 log secrets when wrapping errors.
- Set timeouts on outbound HTTP. Do not use http.DefaultClient for untrusted URLs.
- Compare secrets with subtle.ConstantTimeCompare when the value is a token.
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 Go 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 Go agent often gets wrong, such as an exported function that takes context and returns a wrapped error. 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 Go repo?
Save it as `.github/copilot-instructions.md` in the Go 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 Go example assume?
The example assumes a Go module that gofmt can format. It does not assume a web framework. If the repo uses chi, gin, or the standard net/http, stay with that router.
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 Go
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 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 Bevy
- Copilot instructions for Roblox
- Copilot instructions for Python ML
- Copilot instructions for LangChain