superior-comments

Installation
SKILL.md

Superior Comments

Make comments carry information that the code cannot express clearly. In comment-only tasks, do not alter executable code, formatting beyond the comment, imports, configuration, or generated files.

Keep comments that explain

  • intent or a non-obvious invariant;
  • why an apparently simpler approach is unsafe;
  • protocol, compatibility, security, or legal constraints;
  • units, coordinate systems, ownership, lifecycle, or ordering assumptions;
  • a workaround with enough context to remove it safely;
  • a public API contract that documentation tooling consumes;
  • an actionable TODO with condition, owner/reference, or concrete next step when available.

Do not remove license headers, attribution, generated-file warnings, linter directives, migration notes, or operational instructions without proving they are obsolete.

Remove or rewrite noise

Installs
54
GitHub Stars
19
First Seen
11 days ago