Borrowing it
Nothing to install: this file belongs to srnichols/plan-forge. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/srnichols/plan-forge/master/.github/instructions/clean-code.instructions.mdgit clone --depth 1 https://github.com/srnichols/plan-forgeWrote 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.
[](https://agentmods.dev/instructions/srnichols/plan-forge/clean-code)<a href="https://agentmods.dev/instructions/srnichols/plan-forge/clean-code"><img src="https://agentmods.dev/badge/instructions/srnichols/plan-forge/clean-code/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.
<a href="https://agentmods.dev/instructions/srnichols/plan-forge/clean-code"><img src="https://agentmods.dev/badge/instructions/srnichols/plan-forge/clean-code.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.01959 | $0.01959 |
| Opus 5.5 | $0.00784 | $0.00784 |
| Sonnet 5.5 | $0.00392 | $0.00392 |
| Haiku 4.5 | $0.00196 | $0.00196 |
Grade A, and why
plan-forge clean-code.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 11d 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.
How it starts
The opening of the file, as written. The whole thing — 165 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Clean Code Guardrails
Derived from the Phase 42 Clean-Code Audit (27 findings, 6 categories). Full catalog:
docs/plans/cleanup-findings/CATALOG.md
When writing a function
| Rule | Threshold | Action |
|---|---|---|
| Length | ≤100 lines (warn) / ≤300 lines (error) | Extract helpers; split by single responsibility |
| Complexity | ≤12 paths (warn) / ≤20 paths (error) | Flatten conditionals; extract guard clauses |
| Parameters | ≤4 positional (warn) / ≤6 (error) | Wrap excess args in an options object |
| Nesting depth | ≤3 levels | Invert conditions; extract inner blocks |
Checks before merging a function change:
- Function does exactly one thing (name is a verb phrase, single concern)
- No positional parameter list longer than 4 — use
{ a, b, c }destructuring - No magic numbers — assign to a named
constat module scope - No side effects beyond the function's stated contract
- ESLint
complexity-errorandmax-lines-per-function-errormust be zero
When naming
- Modules / files: noun, kebab-case (
cost-service.mjs, notcs.mjs) - Functions: verb phrase, reveals intent (
buildEstimate, notcalc) - Variables: noun, camelCase; boolean prefixed
is/has/can - Constants: UPPER_SNAKE for true compile-time literals; camelCase
constfor runtime values - Enums / frozen arrays: import from
pforge-mcp/enums.mjs— never hand-type string literals - Avoid:
data,info,result,tmp,val, single letters outside loop indices
When commenting
- Comment why, not what — the code shows what; the comment explains why it had to be this way
- Delete commented-out code; use
gitfor history - JSDoc only on exported API surfaces; inline comments are a last resort
- Do NOT leave
TODO/FIXME/HACKmarkers — create a tracked issue instead console.logmust be intentional CLI output; remove debug leakage before committing
When you spot duplication (DRY)
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.
- 11d ago Changed · +4 lines · +144 tokens per session fcbb5ac90240
- 1mo ago Changed · +32 lines · +315 tokens per session 5301930fe91a
- 1mo ago First seen · 129 lines · 1,500 tokens per session scan A 99308c389ea9
plan-forge clean-code.instructions.md is an instructions file published in the GitHub repository srnichols/plan-forge (6 stars, last pushed today), licensed MIT. It adds 1,959 tokens to every session, about $0.0078 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-31.
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).
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.
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).
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.
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.
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).