clean-code

A set of general code-quality rules for writing readable and maintainable software. It focuses on clear names, small focused functions, useful comments, shared logic, and named constants instead of unexplained numbers.

In plain words
What is it for?
Use it when writing or reviewing code across a project, especially when improving naming, function structure, comments, and reuse.
Why use it?
It reduces confusing code and repeated logic, making changes and reviews easier.

Cursor rule

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 rules/itamarzand88/awesome-agent-conventions/clean-code
Clone the repo
git clone --depth 1 https://github.com/ItamarZand88/awesome-agent-conventions
Per session 408 This file is loaded in full into every session.
When invoked 408 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin 92% copy Near-identical to another mod 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.00408 $0.00408
Opus 5 $0.00204 $0.00204
Sonnet 5 $0.00082 $0.00082
Haiku 4.5 $0.00041 $0.00041

Measured 2d ago against content hash d0f2e2134856, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

clean-code 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 2d 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.

Origin

This is a copy

92% identical to clean-code — 1 line differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

conventions/agent-rules/examples/awesome-cursorrules-clean-code/clean-code.mdc · 58 lines

What it actually says


description: Guidelines for writing clean, maintainable, and human-readable code. Apply these rules when writing or reviewing code to ensure consistency and quality. globs: ["**/*"] alwaysApply: false

Clean Code Guidelines

Constants Over Magic Numbers

  • Replace hard-coded values with named constants
  • Use descriptive constant names that explain the value's purpose
  • Keep constants at the top of the file or in a dedicated constants file

Meaningful Names

  • Variables, functions, and classes should reveal their purpose
  • Names should explain why something exists and how it's used
  • Avoid abbreviations unless they're universally understood

Smart Comments

  • Don't comment on what the code does - make the code self-documenting
  • Use comments to explain why something is done a certain way
  • Document APIs, complex algorithms, and non-obvious side effects

Single Responsibility

  • Each function should do exactly one thing
  • Functions should be small and focused
  • If a function needs a comment to explain what it does, it should be split

DRY (Don't Repeat Yourself)

  • Extract repeated code into reusable functions
  • Share common logic through proper abstraction
  • Maintain single sources of truth

Clean Structure

  • Keep related code together
  • Organize code in a logical hierarchy
  • Use consistent file and folder naming conventions

Encapsulation

  • Hide implementation details
  • Expose clear interfaces
  • Move nested conditionals into well-named functions

Code Quality Maintenance

  • Refactor continuously
  • Fix technical debt early
  • Leave code cleaner than you found it

Testing

  • Write tests before fixing bugs
  • Keep tests readable and maintainable
  • Test edge cases and error conditions

Version Control

  • Write clear commit messages
  • Make small, focused commits
  • Use meaningful branch names
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. 2d ago First seen · 58 lines · 408 tokens per session scan A d0f2e2134856

Subscribe to this mod's changes

clean-code is a cursor rule published in the GitHub repository ItamarZand88/awesome-agent-conventions (29 stars, last pushed 1mo ago), licensed MIT. It adds 408 tokens to every session, about $0.0020 per session on Opus 5. A static security scan graded it A with 0 findings. It is 92% identical to clean-code, differing in 1 line, and is treated as a copy.

Related

Other cursor rules, from other repositories

digital-death-plan

Plan what happens to your digital life when you die — accounts, photos, passwords, money, and social profiles — so someone you trust can actually find, access, memorialize, or close them without a legal nightmare. Use when someone says 'what happens to my accounts when I die', 'digital legacy', 'help my family access…

mohitagw15856/pm-claude-skills · 116 tokens

grief-admin

Get through the brutal logistics after a death — who to notify, what accounts and services to close, in what order, and what genuinely can't wait vs what can wait months — with explicit permission to do it slowly and in pieces. Use when someone says 'my [person] died and I don't know where to start', 'what do I need…

mohitagw15856/pm-claude-skills · 130 tokens

life-premortem

Write the failure story of your year, relationship, move, or big life bet in advance — imagine it's a year later and it went wrong, tell that story vividly, then mine it for the real risks and the cheap things that would have prevented them. Use when someone says 'I'm about to make a big life change', 'what could go…

mohitagw15856/pm-claude-skills · 121 tokens

mechanic-quote-decoder

Read a garage quote or invoice like someone who can't be padded — which line items connect to your actual symptom, which are while-we're-in-there additions, the questions that make soft lines disappear, when a second opinion pays for itself, and the scripts for declining work without souring the relationship. Use when…

mohitagw15856/pm-claude-skills · 129 tokens

used-car-decoder

Decode a used-car listing before you drive an hour to see it — what the seller's phrasing is hiding, the history-check items that matter, a test-drive and inspection checklist ordered by cost-of-miss, the questions that make evasive sellers visible, and the walk-away signs ranked 🔴🟡🟢. Use when someone says 'is this…

mohitagw15856/pm-claude-skills · 129 tokens

deepfake-drill

Run a tabletop drill of a voice-clone or deepfake fraud attempt — the 'CEO needs this wire today' call — against your actual approval process, before a real attacker does, then debrief the tells and fix the process gap. Use when someone asks to train the team on deepfake fraud, test wire-transfer controls, run a…

mohitagw15856/pm-claude-skills · 111 tokens