claude-code-best-practices: Instructions file for Claude Code

CLAUDE.md

claude-code-best-practices CLAUDE.md is an instructions file for Claude Code from MuhammadUsmanGM/claude-code-best-practices. It costs 1,463 tokens per session, scanned A, original, MIT.

Repository instructions for a documentation wiki about Claude Code, with example instruction files, guides, tools, plugins, and starter kits. It has no application build; quality checks cover shell scripts, Markdown, links, and instruction templates.

In plain words
What is it for?
Editing guides and templates, running the instruction-file linter, checking Markdown and links, and understanding the repository's CI quality gates.
Why use it?
They clarify what kind of repository this is and prevent developers from looking for application code or using irrelevant build commands. They also identify the checks that content changes must pass.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is MuhammadUsmanGM/claude-code-best-practices's own configuration. It tells Claude Code how to work on claude-code-best-practices 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 claude-code-best-practices configures →

Reuse

Borrowing it

Nothing to install: this file belongs to MuhammadUsmanGM/claude-code-best-practices. 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/MuhammadUsmanGM/claude-code-best-practices/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/MuhammadUsmanGM/claude-code-best-practices

Made for: Claude Code.

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 claude-code-best-practices CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/muhammadusmangm/claude-code-best-practices/claude-md.svg)](https://agentmods.dev/instructions/muhammadusmangm/claude-code-best-practices/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/muhammadusmangm/claude-code-best-practices/claude-md"><img src="https://agentmods.dev/badge/instructions/muhammadusmangm/claude-code-best-practices/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,463 This file is loaded in full into every session.
When invoked 1,463 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.1 $0.01463 $0.01463
Opus 5 $0.00732 $0.00732
Sonnet 5 $0.00293 $0.00293
Haiku 4.5 $0.00146 $0.00146

Measured 6d ago against content hash 4a48d1385d4c, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

claude-code-best-practices CLAUDE.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 6d 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.

CLAUDE.md · 124 lines

How it starts

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

CLAUDE.md — claude-code-best-practices

This repository is a documentation wiki about Claude Code. It is also a dogfood: the .claude/ directory and this file show how we use Claude Code on the very repo that teaches Claude Code. Read this before making changes.

What this repo is

  • Markdown guides in guides/, stack-specific CLAUDE.md examples in examples/, shell tools in tools/, plugins in plugins/, whole-project starter kits in starters/.
  • No application code. No build step. No package manager for the content itself (mkdocs-material is used only to render the published site).
  • Quality gates are enforced in CI: shellcheck, markdownlint, a link checker, and tools/lint-claude-md.sh against every template.

Commands

This repo has no application build. The "commands" are the lint and content tools. All of them run locally from the repo root.

  • bash tools/lint-claude-md.sh <file> — validate a CLAUDE.md against structure, content-quality, and common-mistake checks.
  • bash tools/lint-claude-md.sh CLAUDE.md — validate this file.
  • bash tools/benchmark.sh --help — show harness flags. Actual runs require claude installed and ANTHROPIC_API_KEY set.
  • bash tools/benchmark-summary.sh — regenerate benchmarks/latest.md from the CSVs under benchmarks/history/.
  • bash tools/generate-claude-md.sh — interactive CLAUDE.md scaffolder (for new projects, not for this repo).
  • shellcheck $(find . -name '*.sh' -not -path './.git/*') — run the same shellcheck gate CI runs.
  • markdownlint '**/*.md' --config .markdownlint.json --ignore-path .markdownlintignore — run the same markdownlint gate CI runs.
  • mkdocs serve — preview the site locally (needs pip install -r requirements-docs.txt).

Testing

The repo has no runtime tests. Correctness is enforced through the four CI gates — each is the "test" for a specific class of error:

  • shellcheck.yml catches shell bugs before merge.
  • markdownlint.yml catches markdown structural errors.
  • links.yml catches broken internal and external links.
  • lint-claude-md.yml catches CLAUDE.md structural errors in every template.

Read the full file on GitHub · 124 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. 6d ago First seen · 124 lines · 1,463 tokens per session scan A 4a48d1385d4c

Subscribe to this mod's changes

claude-code-best-practices CLAUDE.md is an instructions file published in the GitHub repository MuhammadUsmanGM/claude-code-best-practices (78 stars, last pushed 2mo ago), licensed MIT. It adds 1,463 tokens to every session, about $0.0073 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-30.

Related

Other instructions, from other repositories

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

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 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 · 6,785 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 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,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens