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.
lakehqCopilot instructionslakehq/sail/.github/copilot-instructions.md
protocol implementation. - `sail-sql-*`: Sail SQL parser and analyzer. - `sail-telemetry`: OpenTelemetry integration. - `docs/`: Documentation site built with VitePress. - `python/`: Source code for the `pysail` Python package. - `scripts/`: Various scripts
No other project uses it yet
pesterCopilot instructionspester/Pester/.github/copilot-instructions.md
next to the code with `[Diagnostics.CodeAnalysis.SuppressMessageAttribute('Pester.BuildAnalyzerRules\ ', ' ', Justification = '...')]`, matching the existing suppressions in `src/`. ## Documentation - Documentation is written in Markdown; update it when behavior changes. - Use fenced code blocks
delta-ioCopilot instructionsdelta-io/delta-rs/.github/copilot-instructions.md
Public API docs: new public structs, enums, functions, and non-obvious members need documentation in the crate's style, and names should be self-explanatory without abbreviations. - Error handling
apacheCopilot instructionsapache/gravitino/.github/copilot-instructions.md
test classes (e.g., `TestMetalake`). - **Dependencies**: Do NOT add new dependencies without explicit user request. - **Documentation**: JavaDoc is required for all public APIs. ## Language Specifics - **Java**: - Use `@Nullable` for optional fields/params
serverpodCopilot instructionsserverpod/serverpod/.github/copilot-instructions.md
format ` : ` 4. **Complete checklists**: Mark appropriate items in the pre-launch checklist 5. **Document breaking changes**: Always fill in the breaking changes section if applicable ### PR Template Enforcement - **Never create
Steady6 mentions in 2 weeks
No other project uses it yet
stellarCopilot instructionsstellar/stellar-core/.github/copilot-instructions.md
other simple text search tools when seeking information about the codebase. Especially use `lsp_document_symbols` for an overview of any given file
TanStackCopilot instructionsTanStack/ai/.github/instructions/copilot-instructions.md
there's a strong reason to introduce breaking changes. If breaking changes are necessary, document them clearly in the relevant documentation files. Under no circumstances should casting
Steady10 mentions in 2 weeks
No other project uses it yet
dotnetPipes a download into a shellCopilot instructionsdotnet/extensions/.github/copilot-instructions.md
access to internal Microsoft Azure DevOps feeds - **NOT A CODE ISSUE** - environment/network limitation - Document as "Build requires access to internal Microsoft feeds" 3. **SSL connection errors during restore**: - Try disabling
music-assistantCopilot instructionsmusic-assistant/server/.github/copilot-instructions.md
Actionable feedback, not observations. One sentence where one sentence does the job. On documentation or user-facing text, flag wording only when it's genuinely confusing or could mislead someone
Steady13 mentions in 2 weeks
No other project uses it yet
InvoicePlaneReads credentialsCopilot instructionsInvoicePlane/InvoicePlane/.github/copilot-instructions.md
supplied filename. - Do not introduce `mb_strlen` / `mb_substr` on raw binary data (Cryptor). ## Documentation / changelog rules - **Never change CVSSv3 scores, CWE identifiers, or Severity labels** in vulnerability tables unless
Steady5 mentions in 2 weeks
No other project uses it yet
MicrosoftCopilot instructionsmicrosoft/litebox/.github/copilot-instructions.md
affects public interfaces. - Extremely simple changes do not require explicit unit tests. 5. Document all public APIs and non-trivial implementation details. 6. Avoid introducing new dependencies unless strictly necessary
FluidInferenceCopilot instructionsFluidInference/FluidAudio/.github/copilot-instructions.md
types - Error handling: Use proper Swift error handling, no force unwrapping in production - Documentation: Triple-slash comments (`///`) for public APIs - Thread safety: Use actors, `@MainActor`, or proper locking - never `@unchecked
Steady9 mentions in 2 weeks
No other project uses it yet
AvaloniaCommunityCopilot instructionsAvaloniaCommunity/awesome-avalonia/.github/copilot-instructions.md
libraries, tools, samples, and resources maintained in a single README.md file. This is a documentation-only repository with no build processes or code compilation. Always reference these instructions first
SynoCommunityCopilot instructionsSynoCommunity/spksrc/.github/copilot-instructions.md
version requirements in upstream docs - Consider bundling related updates together (e.g., Erlang + RabbitMQ + ejabberd) - Document upgrade warnings in `CHANGELOG` when migrations are needed ### Adding Architecture Support When the limit
subsurfaceCopilot instructionssubsurface/subsurface/.github/copilot-instructions.md
Subsurface AI Coding Agent Guidelines Welcome to the Subsurface codebase! This document provides essential guidelines for AI coding agents to be productive and effective contributors to this project. Subsurface
MicrosoftCopilot instructionsmicrosoft/Generative-AI-for-beginners-dotnet/.github/copilot-instructions.md
organized in numbered folders (`01-IntroductionToGenerativeAI/` through `05-ResponsibleAI/`), each with a `readme.md` for documentation. - All code samples live in the centralized `samples/` directory, organized by category: `CoreSamples/`, `MAF/`, `AppsWithGenAI
MicrosoftCopilot instructionsmicrosoft/agent-skills/.github/copilot-instructions.md
Rust** | `-rust` | `azure-identity-rust`, `azure-cosmos-rust` | ### Featured Skills | Skill | Purpose | |-------|---------| | `azure-search-documents-py` | Search SDK patterns, vector/hybrid search, agentic retrieval | | `azure-ai-agents-py` | Low-level agents
lammpsCopilot instructionslammps/lammps/.github/copilot-instructions.md
specific rules in `.github/instructions/` for the changed files: C++ sources and tests (`source-code`), documentation (`documentation`), KOKKOS (`kokkos`), unit tests (`force-style-tests`), example inputs (`regression-tests`), and the build
Open-Cascade-SASCopilot instructionsOpen-Cascade-SAS/OCCT/.github/copilot-instructions.md
handlers, or special cases for one input. - Input validation is appropriate at a documented boundary. It is not a substitute for fixing an internal invariant that valid input breaks
inspecCopilot instructionsinspec/inspec/.github/copilot-instructions.md
reference repos, and ensure you have the necessary tools installed. The remainder of this document assumes you have done this. ### Customizing the Shared Context Repository The shared-context repository
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.
