tidy-comments

Clean up code comments in the context of current PR/change. Use when user asks to clean up or tidy code comments.

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.

Un comando directo omite el prompt de revisión. Revisa el origen antes de ejecutarlo.

npx skills add https://github.com/josh-project/josh --skill tidy-comments

El comando permanece en una sola línea. Desplázate horizontalmente para revisarlo antes de copiarlo.

¿Prefieres una copia local? Descarga los archivos que SkillsMP tiene disponibles ahora.

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

SKILL.md

Instrucciones de origen · Vista previa de solo lectura

Run integration tests in this repo using "josh compose" tool. Use when the user requests to run integration tests.

name	tidy-comments
description	Clean up code comments in the context of current PR/change. Use when user asks to clean up or tidy code comments.

The goal of this skill is to clean up code comments, rewriting them in a way that minimizes noise, and maximizes useful information for code readers.

Comments should be concise, clear and focused.
Comments should focus on why the code exists; not what it does.
Comments should not plainly restate code in plain language; instead of repeating the logic, comments should signal intent.
Comments that explain code that is already obvious should be avoided altogether.
- Example of a comment that should be removed:
```
// start the server
server.start()?;
```
Comments should be focused on the region of code they're placed in; irrelevant, far-reaching comments that don't help with readability of the code should be removed.
Comments should not include decorative elements: horizontal bars, ASCII boxes, etc.
Comments should not include references to in-progress plans and documents not included in the commit scope: no references future readers can't access.
Comment length should not hurt readability of the code; use long comments sparingly.