outl: Instructions file for GitHub Copilot

.github/copilot-instructions.md

outl copilot-instructions.md is an instructions file for GitHub Copilot from outlmd/outl. It costs 2,975 tokens per session, scanned A, original, MIT.

A pull-request review instruction set for outl, a Rust-based local-first outliner with a tree synchronisation engine. It tells an AI reviewer which project documents to read and which correctness, architecture, and scalability issues to look for.

In plain words
What is it for?
Use it to guide high-level code reviews for changes to outl, especially changes involving its Rust code, synchronisation engine, architecture, CI, commands, hooks, or release process.
Why use it?
It focuses reviews on problems that could cause real-world failures instead of spending attention on formatting already checked by automated tools.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: reads .claude/ paths; mentions CLAUDE.md.

This is outlmd/outl's own configuration. It tells GitHub Copilot how to work on outl 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 outl configures →

Reuse

Borrowing it

Nothing to install: this file belongs to outlmd/outl. 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/outlmd/outl/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/outlmd/outl

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 outl copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/outlmd/outl/copilot-instructions/github.svg)](https://agentmods.dev/instructions/outlmd/outl/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/outlmd/outl/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/outlmd/outl/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 outl copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/outlmd/outl/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/outlmd/outl/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,975 This file is loaded in full into every session.
When invoked 2,975 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.02975 $0.02975
Opus 5.5 $0.01190 $0.01190
Sonnet 5.5 $0.00595 $0.00595
Haiku 4.5 $0.00298 $0.00298

Measured 29d ago against content hash 34d0c4493f71, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

outl 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 29d 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 · 231 lines

How it starts

The opening of the file, as written. The whole thing — 231 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Copilot review instructions — outl

You are reviewing a pull request in outl, a local-first outliner with a CRDT-based tree sync engine, written in Rust. Read this whole file before commenting. Your job is not a style pass — fmt, clippy, and CI already enforce style. Your job is the review a Staff/Principal engineer would give: catch correctness, architecture, and scalability problems that humans miss, and only speak when it matters.

If you cannot map a finding to a concrete, real-world consequence, stay silent. Noise costs reviewer attention; a single sharp comment earns trust.


0. Read these first

  • Root CLAUDE.md — project-wide invariants and conventions.
  • The CLAUDE.md inside the crate(s) the PR touches (e.g. crates/outl-core/CLAUDE.md).
  • CONTRIBUTING.md — the merge bar and "decisions you don't get to revisit".
  • docs/contributing.md — the review policy this file mirrors.
  • docs/development.md — the engineer onramp (build / run / test / debug / CI / release). Load it when the PR touches CI workflows, slash commands, hooks, agents, or anything else a contributor's first 30 minutes depend on.
  • docs/architecture.md, docs/crdt.md, docs/markdown-format.md — load the relevant one when the PR touches that area.
  • The PR description and any linked issue.

Treat the per-crate CLAUDE.md as authoritative over generic Rust opinions. If your suggestion contradicts it, drop the suggestion.



Where the rest of this lives

This file is deliberately short — GitHub recommends repository-wide instructions stay within about two pages, and everything below applies only to certain paths. Copilot loads these in addition to this file whenever a changed file matches their applyTo glob, so a Rust PR gets the Rust bar without a Solid PR paying for it.

File applyTo Carries
instructions/rust.instructions.md **/*.rs Rust quality bar, hot-path performance rules, testing bar
instructions/shared-primitives.instructions.md crates/** The shared primitives catalog — check before approving any new helper
instructions/architecture.instructions.md crates/** Reuse-first violations, documentation-drift blocking
instructions/markdown.instructions.md **/*.md Semantic line breaks, one owner per fact

Read the full file on GitHub · 231 lines

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. 29d ago Changed · +2 tokens per session 34d0c4493f71
  2. 1mo ago Changed · +2 lines · +57 tokens per session ce3394d38df0
  3. 1mo ago Changed · +19 lines · +377 tokens per session 400c176e0dfa
  4. 1mo ago First seen · 210 lines · 2,539 tokens per session scan A 05990554557a

Subscribe to this mod's changes

outl copilot-instructions.md is an instructions file published in the GitHub repository outlmd/outl (222 stars, last pushed yesterday), licensed MIT. It adds 2,975 tokens to every session, about $0.0119 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-09-01.

Related

Other instructions, from other repositories

md-feedback copilot-instructions.md

Copilot instructions for yeominux/md-feedback, covering plan review workflow, before implementing any plan, annotation types and mcp setup.

yeominux/md-feedback · 309 tokens

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,715 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,461 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

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,750 tokens