GitHub Copilot instructions template checker
Choose repository-wide guidance for rules that belong in every task, or a path-specific file for rules that apply to matching files. Generate a starter Markdown file and check common path-pattern mistakes locally in this page.
Create an instruction template
How should I choose the file type?
Put concise shared defaults in .github/copilot-instructions.md. Use a named file ending in .instructions.md inside .github/instructions/ when a rule only applies to certain paths; that file needs an applyTo frontmatter value. GitHub documents that both repository-wide and matching path-specific instructions can be used together. Which types are supported depends on the Copilot surface and task, so check the support matrix for your editor, CLI, cloud agent, or code review workflow.
What does the pattern check cover?
The local check requires at least one relative pattern, rejects empty comma-separated entries, whitespace, absolute paths, parent-directory segments, and characters outside a conservative glob subset. It also checks for balanced square brackets. This is a common-error check, not GitHub's complete glob parser; a passing pattern does not prove a client will match it or load the file. Confirm the current GitHub format and test a representative file in your own Copilot surface.
How can I check that Copilot loaded the instructions?
For Copilot Chat in VS Code, GitHub documents checking the response References list for .github/copilot-instructions.md. Other surfaces have their own behavior and support limits. A Copilot CLI issue records one user's report that a **/*.cs path-specific file was not consistently applied; that report is a qualitative example, not evidence about prevalence or every current version.
What belongs in an instruction file?
Replace the starter comment with short, specific project guidance such as the formatter to run, the test command for a directory, or a repository convention. Keep secrets, access tokens, private keys, and personal data out of instruction files. Review the generated text before committing it, and avoid rules that conflict with other instruction files.
Frequently asked questions
Does this page edit my repository?
No. It creates downloadable text in your browser; it does not read files, contact a service, or write to your repository. Save the output yourself at the suggested path after reviewing it.
Does a valid applyTo pattern guarantee Copilot uses the file?
No. The check only catches a limited set of common syntax mistakes. GitHub documents that instruction support varies by surface and task. Confirm the feature matrix and inspect the context or references available in your client.
Can I put every rule in one repository-wide file?
You can, but GitHub documents path-specific files as a way to keep guidance for particular files separate. Keep repository-wide rules relevant across the project and scope specialized guidance where it belongs.
What evidence supports this helper?
GitHub's documentation defines the repository-wide file, the path-specific file location, and applyTo examples. A public Copilot CLI issue records an individual report about path-specific instruction loading. It is qualitative evidence of a setup question, not a measure of how often the issue occurs.
Sources · checked November 3, 2026
- GitHub Docs: Adding repository custom instructions in your IDE · file formats, applyTo examples, and VS Code references
- GitHub Docs: Support for different types of custom instructions · surface support matrix
- GitHub Copilot CLI issue #2909 · individual report about path-scoped instruction loading · opened Apr 22, 2026
Related: Share repository context across coding agents, Choose a GitHub Copilot agent workflow, and Copilot cloud agent and a second repository.
Methodology and limitations
This browser-only helper generates either the documented repository-wide instructions file or a path-specific .instructions.md file with applyTo frontmatter. Its pattern validator accepts a conservative syntax subset and catches common input mistakes; it is not GitHub’s complete glob parser and cannot confirm client support or runtime loading. GitHub documentation was checked November 3, 2026. One public Copilot CLI issue is cited as a qualitative individual setup report, not prevalence evidence.
Affiliate placeholder {{AFF_TOOLNAME}} — referral link not configured.