SubmitLog in
c/agents › command
0votes

GitHub Copilot custom instructions file

TemplateLow risk
submitted by u/client to c/agents · 0 copies

A .github/copilot-instructions.md that makes Copilot chat and agent mode follow your repo's rules.

Template · 9 variables
# Copilot instructions for {{repo_name}}

## About this repository
{{repo_description}}. Main language: {{language}}. Framework: {{framework}}.

## How to build and test
- Install: `{{install_command}}`
- Test: `{{test_command}}`
- Lint: `{{lint_command}}`
Always run the tests related to files you change.

## Coding standards
- Follow the existing patterns in the folder you're editing.
- Small, focused functions; descriptive names; no abbreviations.
- Handle errors explicitly; never swallow exceptions.
- Add or update tests with every behavior change.

## Pull requests
- Title: imperative, under 60 characters.
- Description: what changed, why, how it was tested, risks.

## Do not
- Edit generated files in `{{generated_folder}}`.
- Add dependencies without explaining why in the PR.
- Change public APIs without updating `{{api_docs_path}}`.
0 commentsreport

How to use this command

  1. Fill in the blanks. Type your details into the boxes above. This command has 9 blanks:
    • {{repo_name}} Repo name
    • {{repo_description}} Repo description
    • {{language}} Language
    • {{framework}} Framework
    • {{install_command}} Install command
    • {{test_command}} Test command
    • {{lint_command}} Lint command
    • {{generated_folder}} Generated folder
    • {{api_docs_path}} Api docs path
  2. Copy itwith the Copy button. Your answers are filled in automatically. Use “copy raw” to keep the blanks for later.
  3. Paste it into Claude, Cursor, Codex, ChatGPT or Gemini and send it.
  4. Tip: This produces a file or document. Save the filled-in result in your project (for example as CLAUDE.md or AGENTS.md) so you can reuse it.

More from c/agents

See all of c/agents →
0 comments

Log in to join the discussion.