readable-code SKILL.md skillA
readable-code from chrisreddington/flight-school is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add chrisreddington/flight-school/readable-code@git:20260524.32ea246Pins git:20260524.32ea246 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- chrisreddington/flight-school
- Path
.github/skills/readable-code/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260524.32ea246, committed May 24, 2026
- Size
- 7,132 bytes
- Repository stars
- 30
- License
- MIT
Use whenever you are writing, reviewing, or refactoring TypeScript/TSX in this repo. Enforces the project's readability contract: self-documenting names, plain control flow, and comments that explain *why* not *what*. Trigger phrases: "clean this up", "make this readable", "refactor", "name this better", "is this code clear?", "review my code".
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
# Readable Code skill > A reader who has **never seen this codebase before** should be able to open > any file and understand what it does without external context. > That is the bar. Everything in this skill exists to defend it. This skill is the practical companion to the readability rules. The authoritative rules live in: - [`.github/instructions/typescript.instructions.md`](../../instructions/typescript.instructions.md) — naming, anti-patterns, validation gates. - [`.github/instructions/documentation.instructions.md`](../../instructions/documentation.instructions.md) — TSDoc proportionality, inline-comment standards. This file is the **how to apply them** layer. ## The four rules ### Rule 1 — Names carry the meaning The variable, function, and type name must tell you what it is **without reading the implementation**. If you have to scan three lines to figure out what `data` holds, the name is wrong. ```typescript // ❌ Generic names force readers to trace data flow const data = await fetch(url).then(r => r.json()); const result = data.items.filter(i => i.x > 0); // ✅ Names answer "what is this?" const profileResponse = await fetch(url).then(r => r.json()); …
Read the whole file at its exact version.
How to install
mdr add chrisreddington/flight-school/readable-code@sha256:81d949c0192918b0The line at the top of this page pins the label git:20260524.32ea246, 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.
[](https://markdownregistry.com/a/art_woqmyus56bfjy3z2)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on May 24, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (7132 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
chrisreddington/flight-school · 30 stars · license MIT · pushed 2026-10-17 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_woqmyus56bfjy3z2 GET https://markdownregistry.com/api/v1/resolve?ref=chrisreddington/flight-school/readable-code GET https://markdownregistry.com/api/v1/blob/81d949c0192918b0812144e40f63f5e49d6f01a0540bb0e84010ae26b8f4d074
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.