clean-code

A set of Clean Code guidelines for making code easier for people to read, maintain, and review. It covers names, comments, focused functions, shared logic, structure, and encapsulation.

In plain words
What is it for?
Writing or reviewing code with named constants, descriptive names, useful comments, single-purpose functions, and consistent organization.
Why use it?
It helps prevent confusing names, repeated code, oversized functions, hidden assumptions, and inconsistent structure.

Cursor rule for Cursor

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/francescojr/nobu/clean-code
Clone the repo
git clone --depth 1 https://github.com/francescojr/nobu

Made for: Cursor.

Per session 462 This file is loaded in full into every session.
When invoked 462 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.00462 $0.00462
Opus 5 $0.00231 $0.00231
Sonnet 5 $0.00092 $0.00092
Haiku 4.5 $0.00046 $0.00046

Measured yesterday against content hash b4cffc901a25, 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 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.

.cursor/rules/clean-code.mdc · 57 lines

How it starts

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

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

  • This project does not practice TDD for every change — use judgment.
  • Prefer reproducing non-trivial bugs with a failing check/smoke before fixing when a test path exists.
  • Cover security-sensitive and data-integrity paths when you touch them.
  • Keep tests readable; cover edge cases and error conditions when you do add them.
  • Do not invent a large test suite for a one-line fix.

Changelog

  • Always update CHANGELOG.md at the end of each incremental change, following semantic versioning and Keep a Changelog conventions (see project AGENTS.md). Cursor session hooks may auto-bump; if they did not run, update the changelog by hand before finishing.

Read the full file on GitHub · 57 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 · 57 lines · 462 tokens per session scan A b4cffc901a25

Subscribe to this mod's changes

clean-code is a cursor rule published in the GitHub repository francescojr/nobu (0 stars, last pushed 23d ago), licensed MIT. It adds 462 tokens to every session, about $0.0023 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-09-01.