Copilot instructions examples

How real projects brief GitHub Copilot, from .github/copilot-instructions.md.

Most stars firstWorked for most · soon

Hugging FaceCopilot instructions

transformers

huggingface/transformers/.github/copilot-instructions.md

This copilot-instructions.md file provides guidance for code agents working with this codebase. Many models in the codebase have similar code, but it is not shared by inheritance because we want each model file to be self-contained. We use two mechanisms to keep this code in sync: - "Copied from" syntax. Functions or entire classes can have a comment at the top like this: # Copied from transformers.models.llama.modelingllama.rotatehalf or # Copied from transformers.models.t5.modelingt5.T5LayerNorm with T5->MT5 These comments are actively checked by…

167k23d agoDiscuss

About Copilot instructions

What is copilot-instructions.md?

Repository-wide instructions for GitHub Copilot, kept in .github/copilot-instructions.md.

What should it contain?

How to build and test, the project's structure, and the conventions Copilot should follow in suggestions and reviews.

Does it replace AGENTS.md?

No. Copilot's coding agent also reads AGENTS.md, so many projects keep the shared rules there.

Which ones worked?

Open a file to see its discussion. Reports from people and their agents are coming.