headroom: Instructions file for GitHub Copilot

.github/copilot-instructions.md

headroom copilot-instructions.md is an instructions file for GitHub Copilot from headroomlabs-ai/headroom. It costs 138 tokens per session, scanned A, original, Apache-2.0.

A set of pull-request review rules for the Headroom repository, the code project hosted at headroomlabs-ai/headroom.

In plain words
What is it for?
Use it when reviewing pull requests, especially changes involving users, releases, dependencies, workflows, or security.
Why use it?
It helps reviewers judge whether a change includes concrete proof that it works, along with the required tests and runtime checks.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is headroomlabs-ai/headroom's own configuration. It tells GitHub Copilot how to work on headroom itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything headroom configures →

About the project

Headroom is a library, proxy, and MCP server that compresses tool outputs, logs, files, retrieval chunks, and conversation history before they reach a language model. It helps coding agents use fewer context tokens while keeping the original content available locally when needed. Its catalogue add-ons support using Headroom with agent workflows.

headroomlabs-ai/headroom · 75,453 stars · on GitHub · docs.headroomlabs.ai

Reuse

Borrowing it

Nothing to install: this file belongs to headroomlabs-ai/headroom. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/headroomlabs-ai/headroom/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/headroomlabs-ai/headroom

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for headroom copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/headroomlabs-ai/headroom/copilot-instructions/github.svg)](https://agentmods.dev/instructions/headroomlabs-ai/headroom/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/headroomlabs-ai/headroom/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/headroomlabs-ai/headroom/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for headroom copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/headroomlabs-ai/headroom/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/headroomlabs-ai/headroom/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 138 This file is loaded in full into every session.
When invoked 138 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00138 $0.00138
Opus 5.5 $0.00055 $0.00055
Sonnet 5.5 $0.00028 $0.00028
Haiku 4.5 $0.00014 $0.00014

Measured 1mo ago against content hash ded6a77597b9, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

headroom copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 8 lines

What it actually says

When performing a pull request review in this repository:

  1. Treat .github/PULL_REQUEST_TEMPLATE.md and CONTRIBUTING.md as required policy, not optional guidance.
  2. Flag pull requests that do not include concrete "Real Behavior Proof" with environment, exact commands or steps, observed result, and what was not tested.
  3. Be strict about contributor verification: missing tests, missing runtime evidence, or placeholder PR text should be called out.
  4. For user-facing, release, dependency, workflow, or security-sensitive changes, prefer blocking feedback over optional suggestions.
  5. Focus on correctness, safety, and whether the PR is actually ready for human maintainer review.
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 8 lines · 138 tokens per session scan A ded6a77597b9

Subscribe to this mod's changes

headroom copilot-instructions.md is an instructions file published in the GitHub repository headroomlabs-ai/headroom (75,453 stars, last pushed today), licensed Apache-2.0. It adds 138 tokens to every session, about $0.0006 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,649 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,257 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,159 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens