Get the FREE Ultimate OpenClaw Setup Guide →

code-review

Scanned
npx machina-cli add skill 686f6c61/alfred-dev/code-review --openclaw
Files (1)
SKILL.md
3.4 KB

Revisión de código

Resumen

Este skill ejecuta una revisión de código exhaustiva centrada en calidad, legibilidad, mantenibilidad y corrección lógica. La revisión no es un trámite burocrático sino una herramienta para mejorar el código y compartir conocimiento dentro del equipo.

Si las herramientas del toolkit pr-review-toolkit están disponibles, este skill las coordina para cubrir múltiples perspectivas: calidad general, fallos silenciosos y oportunidades de simplificación.

Proceso

  1. Entender el contexto del cambio. Antes de revisar línea por línea, entender el propósito del cambio. Leer la descripción del PR, el issue asociado o preguntar al usuario. Un cambio que parece incorrecto puede ser correcto si se entiende el contexto.

  2. Revisar la legibilidad. El código se lee muchas más veces de las que se escribe:

    • Los nombres de variables, funciones y clases son descriptivos?
    • La estructura del código es clara sin necesidad de comentarios explicativos?
    • Las funciones son cortas y con responsabilidad única?
    • Los comentarios explican el "por qué", no el "qué"?
  3. Buscar errores lógicos. Los bugs más peligrosos son los que no producen error:

    • Condiciones invertidas o incompletas.
    • Off-by-one errors en bucles e índices.
    • Variables no inicializadas o reutilizadas incorrectamente.
    • Race conditions en código asíncrono.
    • Falta de manejo de null/undefined/None.
  4. Verificar manejo de errores. Los errores silenciosos son los peores:

    • Los catch/except vacíos se usan sin justificación?
    • Los errores se propagan correctamente o se tragan?
    • El usuario recibe información útil cuando algo falla?
    • Los errores se registran para depuración posterior?
  5. Evaluar la complejidad. El código simple es más fácil de mantener y menos propenso a bugs:

    • Hay condicionales anidados profundamente que se podrían simplificar?
    • Hay duplicación que se podría abstraer?
    • Las abstracciones existentes son justificadas o son sobreingeniería?
  6. Verificar cobertura de edge cases. Para cada función o flujo crítico:

    • Qué pasa con inputs vacíos?
    • Qué pasa con valores extremos (muy grandes, muy pequeños, negativos)?
    • Qué pasa con tipos inesperados?
    • Qué pasa bajo condiciones de error (red, disco, permisos)?
  7. Delegar en herramientas especializadas si están disponibles. Si pr-review-toolkit está disponible:

    • code-reviewer: revisión general de calidad y adherencia a convenciones.
    • silent-failure-hunter: detección de fallos silenciosos y manejo inadecuado de errores.
    • code-simplifier: oportunidades de simplificación sin alterar funcionalidad.

    Umbral de confianza: solo reportar hallazgos con confianza >= 80%.

  8. Documentar hallazgos. Cada hallazgo debe incluir: ubicación en el código, descripción del problema, impacto potencial y sugerencia de corrección.

Criterios de éxito

  • Se han revisado legibilidad, errores lógicos, manejo de errores, complejidad y edge cases.
  • Los hallazgos incluyen ubicación, descripción, impacto y sugerencia de corrección.
  • Solo se reportan hallazgos con confianza >= 80%.
  • El tono de la revisión es constructivo y orientado a mejorar el código.
  • Se distingue entre problemas que bloquean y sugerencias de mejora.

Source

git clone https://github.com/686f6c61/alfred-dev/blob/main/skills/calidad/code-review/SKILL.mdView on GitHub

Overview

Este skill ejecuta una revisión de código exhaustiva centrada en calidad, legibilidad, mantenibilidad y corrección lógica. Si las herramientas del toolkit pr-review-toolkit están disponibles, las coordina para cubrir perspectivas de calidad general, fallos silenciosos y oportunidades de simplificación.

How This Skill Works

Primero entiende el contexto del cambio leyendo la descripción del PR o el issue. Después revisa legibilidad: nombres descriptivos, estructura clara, funciones cortas y comentarios que expliquen el porqué. Luego busca errores lógicos y manejo de errores, evalúa la complejidad y edge cases, y, cuando sea posible, delega en pr-review-toolkit para reportar hallazgos con confianza >= 80%. Documenta cada hallazgo con ubicación, descripción, impacto y corrección.

When to Use It

  • Al revisar un PR para garantizar calidad, legibilidad y corrección lógica.
  • Cuando busques detectar errores lógicos no obvios o fallos silenciosos.
  • Para evaluar manejo de errores y mensajes útiles al usuario.
  • Cuando necesites reducir complejidad o duplicación de código.
  • Al verificar edge cases y entradas atípicas para funciones críticas.

Quick Start

  1. Step 1: Entender el contexto del cambio leyendo la descripción del PR o issue.
  2. Step 2: Revisar legibilidad, nombres y complejidad, y buscar errores lógicos.
  3. Step 3: Documentar hallazgos con ubicación, impacto y corrección; coordinar si es posible con pr-review-toolkit.

Best Practices

  • Entender el contexto del cambio antes de revisar línea por línea.
  • Priorizar nombres descriptivos y funciones cortas con responsabilidad única.
  • Buscar errores lógicos: condiciones invertidas, off-by-one y race conditions.
  • Verificar manejo de errores y mensajes útiles al usuario.
  • Usar pr-review-toolkit cuando esté disponible y reportar hallazgos solo con confianza >= 80%.

Example Use Cases

  • Ejemplo: revisión de PR de autenticación para detectar manejo de errores insuficiente.
  • Ejemplo: detección de condicionales invertidos en lógica de permisos.
  • Ejemplo: identificación de duplicación de código que podría abstraerse.
  • Ejemplo: revisión de edge cases con entradas vacías o tipos inesperados.
  • Ejemplo: detección de fallos silenciosos que no generan error visible pero afectan el flujo.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers