comments-conventions SKILL.md skillA
comments-conventions from msolecki/developer-os is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add msolecki/developer-os/comments-conventions@git:20261108.64cd164Pins git:20261108.64cd164 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- msolecki/developer-os
- Path
plugin/skills/comments-conventions/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261108.64cd164, committed Nov 8, 2026
- First version recorded
- Oct 14, 2026
- Size
- 1,525 bytes
- Repository stars
- 3
- License
- MIT
Write no comment by default, and keep the few that earn their place current. Use when writing or reviewing code comments in TypeScript, JavaScript, Python, or shell files.
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 — last resort only - Write no comment by default. Clear names, small functions and precise types are the documentation. Before writing one, rename the thing or extract a function; that removes the need almost every time. This applies to tests too — a well-named test needs no narration above it. - Never restate what the next line does, never repeat the function name in a header, never explain the change itself: that belongs in the commit message or the PR description, not in the file. - A comment earns its place only when the reader cannot recover it from the code at all: a past bug with its date/ticket, a directive (`eslint-disable`, `@ts-expect-error`, `biome-ignore`), or a genuinely non-obvious mechanical fact about a library or platform. One line, not a paragraph. - Explaining WHY in prose is not a licence to comment. Reserve it for a rejected alternative someone would otherwise "fix" back. If the explanation needs more than a line, it belongs in `docs/pitfalls.md` or a decision record, not next to the code. …
Read the whole file at its exact version.
How to install
claude plugin marketplace add https://markdownregistry.com/mp/a/art_y2gcfdvzvqi4v7rp/55e48ac6b1d7eafeb4e67ad443e233eeae9d665c63eda0157d22d997947d9ab0.json
Then /plugin install comments-conventions@markdownregistry-y2gcfdvzvqi4v7rp in Claude Code. It installs git:20261108.64cd164, the one graded A here, pinned to the commit it was graded at, and leaves it there.
mdr add msolecki/developer-os/comments-conventions@sha256:55e48ac6b1d7eafeThe line at the top of this page pins the label git:20261108.64cd164, 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_y2gcfdvzvqi4v7rp)
1 badge image fetches in 30 days. What the badge shows.
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry
Then ask it: what changed in msolecki/developer-os/comments-conventions since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.
Got a copy of comments-conventions from somewhere else? Ask it: where did my comments-conventions come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.
Versions
The registry has recorded 5 versions of this file, between Oct 14, 2026 and Nov 8, 2026, about one every 6 days.
Watch this file (sign in, one email per new version)
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261108.64cd164 latest | 2026-11-08 | 64cd164 | 1,525 B | A | view · diff |
| git:20261024.8456bc0 | 2026-10-24 | 8456bc0 | 1,534 B | A | view · diff |
| git:20261015.933b000 | 2026-10-15 | 933b000 | 1,570 B | A | view · diff |
| git:20261015.eeda64b | 2026-10-15 | eeda64b | 1,904 B | A | view · diff |
| git:20261014.c8129da | 2026-10-14 | c8129da | 1,826 B | A | view |
Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.
It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.
Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.
mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml
It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.
Installed this file, say at .claude/skills/comments-conventions/SKILL.md? Drop it here to learn which saved version you have and what changed since. Your browser works out its SHA-256 fingerprint and sends only that; the file itself never leaves your computer.
Or paste its contents
Your agent can run this same check on the agent markdown files you have installed, up to 50 in one ask. Add the registry once:
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry
Then ask it to check the files you have installed. No key and no account.
From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.
sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies
In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.
sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies
No sha256sum on your machine? shasum -a 256 prints the same lines.
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 (1525 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
msolecki/developer-os · 3 stars · license MIT · pushed 2026-11-16 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_y2gcfdvzvqi4v7rp GET https://markdownregistry.com/api/v1/resolve?ref=msolecki/developer-os/comments-conventions GET https://markdownregistry.com/api/v1/blob/55e48ac6b1d7eafeb4e67ad443e233eeae9d665c63eda0157d22d997947d9ab0
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.