outl: Instructions file for GitHub Copilot

.github/instructions/rust.instructions.md

outl rust.instructions.md is an instructions file for GitHub Copilot from outlmd/outl. It costs 995 tokens per session, scanned A, original, MIT.

Project instructions for maintaining Rust code quality, error handling, safety comments, and performance in selected library and command-line code.

In plain words
What is it for?
Use them when reviewing or changing Rust libraries, asynchronous functions, public APIs, unsafe code, and error-handling paths.
Why use it?
They help catch unsafe code, hidden errors, blocking work in asynchronous code, and inefficient public APIs before they become problems.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: 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/instructions/rust.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 rust.instructions.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/outlmd/outl/rust"><img src="https://agentmods.dev/badge/instructions/outlmd/outl/rust.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 995 This file is loaded in full into every session.
When invoked 995 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.00995 $0.00995
Opus 5.5 $0.00398 $0.00398
Sonnet 5.5 $0.00199 $0.00199
Haiku 4.5 $0.00100 $0.00100

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

Security

Grade A, and why

outl rust.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/instructions/rust.instructions.md · 75 lines

How it starts

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

Rust quality bar

Comment when the diff introduces any of the following. Skip when the existing surrounding code already does it (that's a separate cleanup).

  • .unwrap() outside #[cfg(test)] — require .expect("explicit reason") or ? propagation. The expect message must name the invariant being asserted, not just "should not fail".
  • .unwrap_or_default() masking an error path — if the default is a silent data-loss bug, flag it.
  • unsafe in outl-core without a // SAFETY: comment naming the invariants the caller relies on.
  • anyhow in a library crate (outl-core, outl-md, outl-actions). Libraries use thiserror so callers can match on variants. anyhow is only OK at binary boundaries (outl-cli, outl-tui).
  • Box<dyn Error> as a public return type — same reason.
  • String where &str works, Vec<T> where &[T] works, owned arg where borrowed works — but only in public APIs and hot paths; do not bikeshed this on internal helpers.
  • async fn with a blocking call inside (std::fs, std::thread::sleep, large CPU loop without spawn_blocking).
  • Holding a Mutex/RwLock across an .await — deadlock waiting to happen.
  • Public API change on outl-core, outl-md, or outl-actions without doc-comment update — the per-crate CLAUDE.md should also reflect it.

Skip these (CI / fmt / clippy handle them):

  • Import ordering, line width, brace placement.
  • Naming conventions clippy already lints.
  • mod declaration order.

Performance — hot paths only

Comment on performance only when the code is on a path that runs frequently or scales with workspace size. Do not flag allocations in setup, error paths, or one-shot CLI commands.

Paths that are hot in outl:

  • outl_core::tree — every op apply, every materialized-tree walk.
  • outl_core::log — every append, every replay (workspace boot, sync pull).
  • outl_md::parse / outl_md::render — every .md read/write, every TUI refresh of a buffer.
  • outl_md::index — backlink index rebuild scales with workspace size.
  • outl_tui render loop — runs on every keystroke.
  • outl_actions::SyncEngine work loop — runs on every file event.

Read the full file on GitHub · 75 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. 1mo ago First seen · 75 lines · 995 tokens per session scan A 0ff7ee36db6a

Subscribe to this mod's changes

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

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

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