Home / amey-thakur / ai-skills · GitHub

code-comments SKILL.md skillA

code-comments from amey-thakur/ai-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add amey-thakur/ai-skills/code-comments@git:20260718.7c1285c

Pins git:20260718.7c1285c in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: amey-thakur/ai-skills
Path: skills/code-quality/code-comments/SKILL.md
Versions recorded: 1
Latest version: git:20260718.7c1285c, committed Jul 18, 2026
Size: 2,781 bytes
Repository stars: 14
License: MIT

Write comments that record why the code is shaped as it is, and delete the ones that only restate it. Use when adding, reviewing, or pruning comments in a codebase.

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

Code says what happens; a good comment says why it had to happen that way. The
dangerous comment is the one that repeats the code beside it: it rots the moment
that line changes, and now it lies to everyone who trusts it.

## Method

1. **Comment the why, never the what.** `// increment i` is noise;
   `// skip the header row: the export tool emits a BOM line` carries a reason
   no reader could recover from the code. If a comment paraphrases the
   statement, delete the comment, not the reader's attention.
2. **Pin every constraint to its source.** When a value comes from outside the
   code, cite it: `// Stripe caps metadata at 500 chars` or
   `// must match the ORDER_STATUS enum in the orders service`. Such comments
   defend a line against a well-meaning simplification that would break a
   contract.
3. **Write doc comments for the caller, not the maintainer.** On a public
   function, state what it returns, what it throws, and the units and ranges of
   arguments: `timeout in milliseconds; 0 disables`. Skip restating the body.
   The reader is deciding whether to call, not studying how it works.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add amey-thakur/ai-skills/code-comments@sha256:bf3c5ceb802958d3

The line at the top of this page pins the label git:20260718.7c1285c, 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](https://markdownregistry.com/badge/art_5jh3eyloaft4vrp7.svg)](https://markdownregistry.com/a/art_5jh3eyloaft4vrp7)

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

Versions

The registry has recorded 1 version of this file, committed on Jul 18, 2026.

version	committed	commit	size	audit
git:20260718.7c1285c latest	2026-07-18	7c1285c	2,781 B	A	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 (2781 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

amey-thakur/ai-skills · 14 stars · license MIT · pushed 2026-09-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_5jh3eyloaft4vrp7
GET https://markdownregistry.com/api/v1/resolve?ref=amey-thakur/ai-skills/code-comments
GET https://markdownregistry.com/api/v1/blob/bf3c5ceb802958d3b491dcdf3024d6c05c319a662089afa03ec8962925922dfc

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 amey-thakur/ai-skills

ai-skills Cursor rule

amey-thakur/ai-skills · .cursor/rules/ai-skills.mdc · Operate the AI-SKILLS library autonomously, selecting the right skill or prompt for each task.

git:20260721.9534dd9 · audit A · 14 stars

AGENTS.md AGENTS.md file

amey-thakur/ai-skills · AGENTS.md

git:20260728.aa354e7 · audit A · 14 stars

CLAUDE.md CLAUDE.md file

amey-thakur/ai-skills · CLAUDE.md

git:20260721.9534dd9 · audit A · 14 stars

llms.txt@docs llms.txt file

amey-thakur/ai-skills · docs/llms.txt

git:20260728.f55fde9 · audit B · 14 stars

llms.txt llms.txt file

amey-thakur/ai-skills · llms.txt

git:20260906.c8c8420 · audit B · 14 stars

accessibility-review SKILL.md skill

amey-thakur/ai-skills · skills/accessibility/accessibility-review/SKILL.md · Audit a UI for real accessibility, keyboard-first, with concrete failures and fixes rather than checkbox compliance…

git:20260718.7c1285c · audit A · 14 stars

accessible-forms SKILL.md skill

amey-thakur/ai-skills · skills/accessibility/accessible-forms/SKILL.md · Build forms with associated labels, identified errors, clear instructions, and autocomplete attributes. Use when…