principle-clean-code SKILL.md skillA

principle-clean-code from lugassawan/swe-workbench is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add lugassawan/swe-workbench/principle-clean-code@git:20260924.21f932a

Pins git:20260924.21f932a in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
lugassawan/swe-workbench
Path
skills/principle-clean-code/SKILL.md
Versions recorded
5
Latest version
git:20260924.21f932a, committed Sep 24, 2026
First version recorded
Jul 19, 2026
Size
7,848 bytes
Repository stars
3
License
MIT

Clean code, DRY, KISS, YAGNI, function length, abstraction level, function argument count, Boy Scout Rule, intent-revealing naming. Auto-load when writing functions, reviewing code clarity, or debating whether to abstract.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

<!-- preload-canary: SWB-PRELOAD-PRINCIPLE-CLEAN-CODE -->

# Clean Code

## Function Rules

| Rule | Guideline |
|------|-----------|
| **Function length** | Prefer under 20 lines. Extract when doing two things. |
| **Naming** | Name reveals intent. No abbreviations except universal ones (ctx, err, id). |
| **Abstraction level** | One level per function. Don't mix SQL strings with business logic. |
| **Comments** | Explain WHY, not WHAT. If code needs WHAT comments, rename or extract. See Comment discipline. |
| **Error handling** | Handle at the appropriate layer. Don't swallow errors silently. |
| **Argument count** | 0 is ideal; 1 is common; 2 is acceptable; 3+ is suspicious. A boolean flag argument is a hidden second function — split it. |
| **Command-Query Separation** | A function either changes state or returns a value — not both. |

## Comment discipline
*A comment is a cost paid on every future read — spend the budget on WHY, not WHAT.*

Doc-comment styles, named so authoring and review flows share one term set:

| Style | Language | Soft cap |
|-------|----------|----------|
| Inline (`//`, `#`) | any | ≤2 lines |
| godoc | Go | ~4 lines |
| javadoc | Java | ~10 lines |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add lugassawan/swe-workbench/principle-clean-code@sha256:05814069e7abe509

The line at the top of this page pins the label git:20260924.21f932a, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_f5tjra27ndp2c2xa.svg)](https://markdownregistry.com/a/art_f5tjra27ndp2c2xa)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between Jul 19, 2026 and Sep 24, 2026, about one every 17 days.

versioncommittedcommitsizeaudit
git:20260924.21f932a latest2026-09-24 21f932a 7,848 BA view · diff
git:20260828.71a63992026-08-28 71a6399 7,549 BA view · diff
git:20260811.925e30f2026-08-11 925e30f 7,638 BA view · diff
git:20260725.074b4962026-07-25 074b496 7,624 BA view · diff
git:20260719.e1f78e02026-07-19 e1f78e0 7,566 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (7848 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

lugassawan/swe-workbench · 3 stars · license MIT · pushed 2026-11-07 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_f5tjra27ndp2c2xa
GET https://markdownregistry.com/api/v1/resolve?ref=lugassawan/swe-workbench/principle-clean-code
GET https://markdownregistry.com/api/v1/blob/05814069e7abe509cfdc479add8c3e1902ba0b4a8f8590bf69596767acb28913

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from lugassawan/swe-workbench

comms-context SKILL.md skill
lugassawan/swe-workbench · skills/comms-context/SKILL.md · Fetch on-call and discussion context from Slack threads and PagerDuty incidents — participants, timeline, and status…
git:20260828.71a6399 · audit A · 3 stars
language-bash SKILL.md skill
lugassawan/swe-workbench · skills/language-bash/SKILL.md · Bash idioms — strict mode, parameter expansion, arrays, trap cleanup, heredocs, and POSIX portability. Auto-load when…
git:20260828.71a6399 · audit A · 3 stars
language-csharp SKILL.md skill
lugassawan/swe-workbench · skills/language-csharp/SKILL.md · C# and .NET idioms — .NET 8 LTS, C# NRT, records, value semantics, switch expressions, async/await, Task, ValueTask…
git:20260828.71a6399 · audit A · 3 stars
language-dart SKILL.md skill
lugassawan/swe-workbench · skills/language-dart/SKILL.md · Dart idioms — null safety, Futures and Streams, widget composition, and Riverpod app architecture. Auto-load when…
git:20260828.71a6399 · audit A · 3 stars
language-go SKILL.md skill
lugassawan/swe-workbench · skills/language-go/SKILL.md · Go idioms — error handling, concurrency, and standard library usage. Auto-load when working with .go files, go.mod…
git:20260828.71a6399 · audit A · 3 stars
language-java SKILL.md skill
lugassawan/swe-workbench · skills/language-java/SKILL.md · Java idioms — records, sealed types, virtual threads, and JDK 21+ patterns. Auto-load when working with .java files…
git:20260828.71a6399 · audit A · 3 stars
language-kotlin SKILL.md skill
lugassawan/swe-workbench · skills/language-kotlin/SKILL.md · Kotlin idioms — null safety, sealed interfaces, scope functions, and Flow. Auto-load when working with .kt files…
git:20260828.71a6399 · audit A · 3 stars
language-python SKILL.md skill
lugassawan/swe-workbench · skills/language-python/SKILL.md · Python idioms — PEP 8, context managers, generators, asyncio, and testing. Auto-load when working with .py files…
git:20260828.71a6399 · audit A · 3 stars
language-ruby SKILL.md skill
lugassawan/swe-workbench · skills/language-ruby/SKILL.md · Ruby idioms — Ruby 3.x pattern matching, procs, Comparable, error handling, and testing. Auto-load when working with…
git:20260828.71a6399 · audit A · 3 stars
language-rust SKILL.md skill
lugassawan/swe-workbench · skills/language-rust/SKILL.md · Rust idioms — ownership, lifetimes, and iterators. Auto-load when working with .rs files, Cargo.toml, or when the user…
git:20260828.71a6399 · audit A · 3 stars
language-sql SKILL.md skill
lugassawan/swe-workbench · skills/language-sql/SKILL.md · SQL idioms — query tuning, table definitions, constraints, transactions, and pagination. Auto-load when working with…
git:20260828.71a6399 · audit A · 3 stars
language-swift SKILL.md skill
lugassawan/swe-workbench · skills/language-swift/SKILL.md · Swift idioms — optionals, value types, async/await, and Result builders. Auto-load when working with .swift files…
git:20260828.71a6399 · audit A · 3 stars

Every file in lugassawan/swe-workbench

Browse by kind, by grade A, or by owner.