loadout readme.instructions.md

A set of required rules for writing the top-level README, the main document that explains how to understand and start using a repository.

In plain words
What is it for?
Structuring and validating READMEs for services, libraries, SDKs, infrastructure projects, and templates.
Why use it?
It keeps onboarding information in a consistent place and requires claims to be supported by evidence.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/stefaniuk/loadout/readme
Clone the repo
git clone --depth 1 https://github.com/stefaniuk/loadout

Made for: GitHub Copilot.

Per session 3,002 This file is loaded in full into every session.
When invoked 3,002 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.03002 $0.03002
Opus 5 $0.01501 $0.01501
Sonnet 5 $0.00600 $0.00600
Haiku 4.5 $0.00300 $0.00300

Measured yesterday against content hash 35df5e1c0cff, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

loadout readme.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 yesterday.

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/readme.instructions.md · 172 lines

How it starts

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

README Engineering Instructions 📘

These instructions define the required structure and content for every repository's top-level README so that users and engineers can trust it as the single onboarding entry point.

They must remain applicable to:

  • Product and platform services (internal or open-source)
  • Libraries, SDKs, tooling, and infrastructure repos
  • Template or example projects that seed new services

They are non-negotiable unless an explicit ADR grants a scoped, time-bound exception.

Identifier scheme. Every normative rule carries a unique tag in the form [RD-<prefix>-NNN], where the prefix maps to the containing section (for example QR for Quick Reference, STR for Structure, SEC for Section requirements). Use these identifiers when planning or validating documentation work.


0. Quick reference (apply first) 🧠

  • [RD-QR-001] Follow the canonical section order defined in [RD-STR-001] so readers always know where to find information.
  • [RD-QR-002] Base every statement on evidenced sources per [RD-GOV-002]; never invent behaviour or guarantees.
  • [RD-QR-003] Use explicit TODO: placeholders whenever information is missing or unverified ([RD-GOV-003]).
  • [RD-QR-004] Keep the opening section short enough for readers to understand purpose, benefit, problem, and approach within 30 seconds ([RD-GOV-005], [RD-VAL-001]).
  • [RD-QR-005] Quick start content must document prerequisites, setup, first run, and expected success indicators using repository-supported commands ([RD-SEC-007]–[RD-SEC-012]).
  • [RD-QR-006] Always provide a Contributing path with links, dev setup, and quality commands ([RD-SEC-025]–[RD-SEC-028]).
  • [RD-QR-007] Use relative links for all in-repo references and include the standard docs/security links when they exist ([RD-LNK-001]–[RD-LNK-002]).
  • [RD-QR-008] Run the validation checklist in [RD-VAL-001]–[RD-VAL-006] before finalising any README change.

1. Purpose and outcomes 🎯

  • [RD-PUR-001] The README must explain the project quickly and clearly to new readers.
  • [RD-PUR-002] It must state why the reader should care by emphasising tangible benefits or outcomes.
  • [RD-PUR-003] It must describe the problem the project solves and outline the high-level approach.
  • [RD-PUR-004] It must provide a fast, reliable path to using the project successfully.
  • [RD-PUR-005] It must provide a clear path for engineers to contribute, test, and extend the project.

Read the full file on GitHub · 172 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. yesterday First seen · 172 lines · 3,002 tokens per session scan A 35df5e1c0cff

Subscribe to this mod's changes

loadout readme.instructions.md is an instructions file published in the GitHub repository stefaniuk/loadout (1 stars, last pushed 3d ago), licensed MIT. It adds 3,002 tokens to every session, about $0.0150 per session on Opus 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-31.