lwlee2608/agent-skills

trim-comments

Use when asked to trim, clean up, shorten, or remove code comments.

Vedi sorgente

Come usare

  1. Copia il comando e controlla il pacchetto prima di installarlo nel tuo ambiente agente.
  2. Controlla strumenti, credenziali e ambienti richiesti nel documento originale.
  3. Descrivi input e risultato desiderato; confronta l’output con le fonti.
npx skills add https://github.com/lwlee2608/agent-skills --skill trim-comments

Prima di iniziare

  • L’installazione non include abbonamenti, quote API o accesso ai file.
  • Stelle e installazioni indicano attività, non un test indipendente di qualità o sicurezza.
Documento Skill originale

Contenuto dal repository con titoli, esempi, codice, tabelle, link e immagini preservati.

Trim Comments

Reduce comment noise. normal (default) shortens wordy comments but keeps their meaning — shorter, not cryptic; never deletes. aggressive deletes nearly every comment. Use aggressive only when the user says so ("aggressive", "strip", "remove all").

Two rules always hold:

  • Edit comments only — never change a line of executable code.
  • Scope: unless the user names files, trim only changed code — the uncommitted local diff first, then the PR diff. Touch the whole codebase only when explicitly asked.

What each mode does

COMMENT TYPE                          NORMAL              AGGRESSIVE
─────────────────────────────────────────────────────────────────────
Restatement (// create user)          shorten             DELETE
Narration (// loop over users)        shorten             DELETE
Echo docstring (Gets name)            shorten             DELETE
Plain why-comment                     keep (shortened)    DELETE
TODO / FIXME / HACK                   keep                DELETE
Doc comment (godoc etc.)              keep (shortened)    stub if lint needs it, else DELETE
Unusual workaround / gotcha           keep (shortened)    KEEP but trim shorter
─────────────────────────────────────────────────────────────────────
Tooling directives (//go:generate…)   never touch         never touch
License / copyright headers           never touch         never touch

Notes

  • Unusual workaround = a non-obvious gotcha, a bug being worked around, a "must do X or Y breaks" note. Aggressive keeps these but trims to the shortest form that still conveys the reason.
  • Tooling directives (//go:generate, //go:embed, # noqa, # type: ignore, // eslint-disable, // @ts-expect-error, // nolint) and license headers look like comments but aren't noise — deleting them changes behavior or has legal weight. Never touch them at either level.
dallo stesso repository

Altri Skills

Tutti gli Skills