rust-comment-hygiene

star 1

When to write a comment and when not to. Delete provenance/process markers (review-round refs like codex R8-F1 / Round 3, audit/seed/milestone tags, attribution); a comment must earn its place by explaining WHY — an invariant, a non-obvious ordering, a safety argument, a reference-implementation design note — never by restating WHAT the code and its names already say. Keep public-API doc comments (`///` and `//!`); delete redundant narration, commented-out code, and banner noise. Prefer a clearer name over a comment. Use when writing or reviewing any comment or doc comment in Rust code.

al8n By al8n schedule Updated 6/4/2026

Skill instructions (SKILL.md) could not be loaded from local cache or raw GitHub repository.

Install via CLI
npx skills add https://github.com/al8n/rust-golden-skills --skill rust-comment-hygiene
Repository Details
star Stars 1
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator