code-commenting-guidelines SKILL.md skillA
code-commenting-guidelines from seedcord/seedcord is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add seedcord/seedcord/code-commenting-guidelines@git:20261021.1a58128Pins git:20261021.1a58128 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- seedcord/seedcord
- Path
.agents/skills/code-commenting-guidelines/SKILL.md- Versions recorded
- 3
- Latest version
- git:20261021.1a58128, committed Oct 21, 2026
- First version recorded
- Oct 7, 2026
- Size
- 9,915 bytes
- Repository stars
- 26
- License
- Apache-2.0
Use this when writing, refactoring, or reviewing TypeScript code. Decides whether a comment should exist at all, which is usually no. Covers the code fixes to try first, the four facts a name can never carry, and how a comment should sound once you write one.
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
# Comments Most code needs none. Fix the code first. When the reason sits outside the file and no name can hold it, write one line the way you would say it out loud. For _how_ the line should read once you decide to write it, this skill and `writing-voice` both apply. That one covers word choice everywhere. This one covers whether the comment exists. --- ## 1. Try the code first Try a comment last. Each fix below deletes the comment by making the code say the thing. ### Rename ```ts // bad // the running item count let n = 0; // good let itemCount = 0; ``` ### Move the words into a function name ```ts // bad // a quick tunnel hostname disappears when the process exits, clear the endpoint if (kind === 'quick') await endpoint.clear(); // good if (hostnameDiesWithProcess(kind)) await endpoint.clear(); ``` The comment became the predicate name. Now it shows up at every call site and the compiler keeps it honest. ### Name the number ```ts // bad await wait(4000); // cloudflare needs a moment // good const DNS_PROPAGATION_MS = 4000; await wait(DNS_PROPAGATION_MS); ``` …
Read the whole file at its exact version.
How to install
mdr add seedcord/seedcord/code-commenting-guidelines@sha256:0b23e1089615a0ffThe line at the top of this page pins the label git:20261021.1a58128, 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_ms73ophunn4x5tkd)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Oct 7, 2026 and Oct 21, 2026, about one every 7 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261021.1a58128 latest | 2026-10-21 | 1a58128 | 9,915 B | A | view · diff |
| git:20261020.e57e1e6 | 2026-10-20 | e57e1e6 | 9,823 B | A | view · diff |
| git:20261007.971bc2b | 2026-10-07 | 971bc2b | 9,567 B | A | view |
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 (9915 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
seedcord/seedcord · 26 stars · license Apache-2.0 · pushed 2026-10-22 · branch next
API
GET https://markdownregistry.com/api/v1/artifacts/art_ms73ophunn4x5tkd GET https://markdownregistry.com/api/v1/resolve?ref=seedcord/seedcord/code-commenting-guidelines GET https://markdownregistry.com/api/v1/blob/0b23e1089615a0ff964877ce86cbc40390c8e1015672d07b45c1cc960462b5dd
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.