code-comments SKILL.md skillA
code-comments from galvarcus/claude-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add galvarcus/claude-skills/code-comments@git:20261018.86a6f57Pins git:20261018.86a6f57 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- galvarcus/claude-skills
- Path
skills/code-comments/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261018.86a6f57, committed Oct 18, 2026
- Size
- 7,024 bytes
- Repository stars
- 3
- License
- GPL-3.0
Write, edit, or review comments in any file that can hold them, using this project's comment standards. Covers source code in any language, shell and Vim scripts, Python, Lua, YAML and CI workflows, TOML, LaTeX, CSS, HTML, and Markdown. The rules state why, not what; forbid inline comments; keep blocks to 78 columns; mark blocks with identifiers such as FUNCTION: and TODO:; and link GitHub issues on REFERENCE: lines. Use whenever writing or changing code, configuration, or templates, even when…
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
# Code Comments ## Scope These rules apply to every comment in every file that can hold one: source code, scripts, configuration, CI workflows, templates, style sheets, and markup. * A language or project skill may add specifics, such as the fields of a file header. Follow both. On a conflict, the more specific skill wins. * A doc comment that a tool reads, such as a Python docstring, a Go doc comment, or JSDoc, keeps the form that the tool expects. The writing rules still apply to its text. The identifiers do not. * Generated files and vendored code keep their comments as they are. ## Principles Good code should explain itself. Before adding a comment, ask whether the code can be changed so the comment is unnecessary. When a comment is necessary, state **why**, not merely **what** the code does. * Omit needless comments. Prefer clear code over comments that explain unclear code. * Explain **rationale, intent, constraints, or non-obvious consequences**, not mechanics that the code already makes clear. * Keep comments **brief, specific, and concrete**. Omit vague or unnecessary words. * Use direct, declarative language. Prefer strong verbs and specific nouns. …
Read the whole file at its exact version.
How to install
mdr add galvarcus/claude-skills/code-comments@sha256:522e3d0ca7585332The line at the top of this page pins the label git:20261018.86a6f57, 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_va344ipgkhshqefy)
0 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 18, 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 (7024 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
galvarcus/claude-skills · 3 stars · license GPL-3.0 · pushed 2026-10-23 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_va344ipgkhshqefy GET https://markdownregistry.com/api/v1/resolve?ref=galvarcus/claude-skills/code-comments GET https://markdownregistry.com/api/v1/blob/522e3d0ca75853327d1693f61f7e95c73f2c373aef6f4f456c4d1bd579b8604a
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 galvarcus/claude-skills
Every file in galvarcus/claude-skills