How real projects brief GitHub Copilot, from .github/copilot-instructions.md.
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
xemu-projectCopilot instructionsxemu-project/xemu/.github/copilot-instructions.md
When performing a code review, consider developer documentation located at `/docs/devel`. Style guide is located at `/docs/devel/style.rst
2 projects use a version of this
getwudCopilot instructionsgetwud/wud/.github/copilot-instructions.md
Backend E2E): Cucumber / Gherkin test suite. - `ui-e2e/` (Frontend E2E): Playwright test suite. - `website/` (Documentation): Docusaurus site. 2. **Validation & Configuration**: - Always validate any configuration or user options with **Joi** schemas
f4exbCopilot instructionsf4exb/sdrangel/.github/copilot-instructions.md
Scripts written in Python to interact with the WebAPI - `doc/img/` — images used in the documentation - `doc/model/` — architecture diagrams and models - Architecture notes (why things are organized this way) - Plugin-first
thomasnordquistReads credentialsCopilot instructionsthomasnordquist/MQTT-Explorer/.github/copilot-instructions.md
theme providers ## Styling Conventions When modifying or creating UI components, follow the styling patterns documented in STYLING.md . **Key points for AI agents:** - Use Material-UI (MUI) v7 components with `withStyles
rstudioCopilot instructionsrstudio/bookdown/.github/copilot-instructions.md
Compact code**: Avoid `{}` for single-expression if statements; prefer compact forms when possible - **Roxygen documentation**: Don't use `@description` or `@details` explicitly - just write the description text directly after
maplibreCopilot instructionsmaplibre/martin/.github/copilot-instructions.md
Pragmatic incrementalism * Avoid over-generic abstractions. * Prefer specific, composable logic. * Evolve designs incrementally and document trade-offs when they matter. ### Production-grade Rust engineering * Use the type system aggressively (newtypes
No other project uses it yet
rejettoCopilot instructionsrejetto/hfs/.github/copilot-instructions.md
existing patterns. - Config: configuration keys and defaults live in `src/config.ts` and `central.json`. `config.md` documents runtime config. The runtime config file is `config.yaml` in the cwd by default. - Environment flags
primerCopilot instructionsprimer/react/.github/copilot-instructions.md
Node.js version updates:** - When updating Node.js, update `.nvmrc` and `.devcontainer/devcontainer.json` together. Also check contributor documentation for any hardcoded Node.js version guidance, such as `contributor-docs/CONTRIBUTING.md`. - GitHub Actions workflows
No other project uses it yet
pimcoreCopilot instructionspimcore/pimcore/.github/copilot-instructions.md
features organized modularly - `lib/` - Core application code, services, and utilities - `models/` - Domain models (Asset, Document, DataObject, User, etc.) - `config/` - Configuration files and service definitions - `templates/` - Twig templates - `bin/` - Console application
SchemaStoreCopilot instructionsSchemaStore/schemastore/.github/copilot-instructions.md
enums - Don't add complex regex patterns for cron strings, URLs, or DSLs 4. **Document Everything**: - Use `description` fields with format: ` \n ` - Mark undocumented features with `UNDOCUMENTED.` prefix in description
seanmorley15Reads credentialsCopilot instructionsseanmorley15/AdventureLog/.github/copilot-instructions.md
source: `frontend/src/` - Backend source: `backend/server/` - Static assets: `frontend/static/` - Database: Handled by Docker PostgreSQL container - Documentation: `documentation/` folder
neomuttCopilot instructionsneomutt/neomutt/.github/copilot-instructions.md
structs and typedefs - **Constants**: UPPER_CASE for macros and enum values - **Files**: snake_case.c/h ### Documentation - **File headers**: Every file must have a Doxygen `@file` comment describing its purpose - **Function comments
MicrosoftCopilot instructionsmicrosoft/mcp/.github/copilot-instructions.md
Guidelines - Ensure all tests pass - Follow the [contribution guidelines](https://github.com/microsoft/mcp/blob/main/CONTRIBUTING.md) - Include appropriate documentation - Include tests that cover your changes - Update CHANGELOG.md with your changes - Run `.\eng\common\spelling
domoticzCopilot instructionsdomoticz/domoticz/.github/copilot-instructions.md
Discuss new features on forum before implementation - Ensure changes align with project direction - Update documentation if relevant - Test thoroughly before submitting - **Never include the `extern/` folder in pull requests
pwa-builderCopilot instructionspwa-builder/PWABuilder/.github/copilot-instructions.md
Guidelines for building C# and TypeScript applications
dathereCopilot instructionsdathere/qsv/.github/copilot-instructions.md
ecosystem. Currently, its been seeded with tab completions and Jupyter notebooks. - `/docs`: Contains documentation for the project, including API specifications and user guides. - `/resources`: Contains examples, vendored code, and test
Steady7 mentions in 2 weeks
No other project uses it yet
borglabCopilot instructionsborglab/gtsam/.github/copilot-instructions.md
Public C++ APIs * All functions in header files should have Doxygen-style API documentation using `/** */`, except small functions such as getters, which can use a single-line `///` comment. There
geekjourneyxCopilot instructionsgeekjourneyx/md2wechat-skill/.github/copilot-instructions.md
bash scripts/quality-gates.sh` runs this as step 0 (fail-fast, < 1 second) before lint/test. ### Documentation Sync Any change to CLI commands, flags, JSON output shape, providers, themes, or prompts must also
Ar9avReads credentialsCopilot instructionsAr9av/obsidian-wiki/.github/copilot-instructions.md
operation. ## Skills Reference | Skill | Folder | Purpose | |---|---|---| | Setup | `skills/wiki-setup/` | Initialize vault structure | | Ingest | `skills/wiki-ingest/` | Distill documents into wiki pages, plus any text data — chat exports, logs, transcripts | | History Router | `skills/wiki-history-ingest/` | Route
Steady5 mentions in 2 weeks
No other project uses it yet
MicrosoftCopilot instructionsmicrosoft/WinUI-Gallery/.github/copilot-instructions.md
picked up by `AxeScanAllTests` which navigates to every page and asserts zero accessibility violations. ## Documentation Reference When looking up API references, control usage, or platform guidance, use the Microsoft Learn
Repository-wide instructions for GitHub Copilot, kept in .github/copilot-instructions.md.
How to build and test, the project's structure, and the conventions Copilot should follow in suggestions and reviews.
No. Copilot's coding agent also reads AGENTS.md, so many projects keep the shared rules there.
Open a file to see its discussion. Reports from people and their agents are coming.
