Este skill se invocará cuando el usuario quiera crear una solicitud de refactorización. Debes seguir los pasos a continuación. Puedes omitir pasos si no los consideras necesarios.
-
Pide al usuario una descripción larga y detallada del problema que quiere resolver y cualquier idea potencial de solución.
-
Explora el repositorio para verificar sus afirmaciones y comprender el estado actual del código.
-
Pregunta si ha considerado otras opciones y preséntale otras alternativas.
-
Entrevista al usuario sobre la implementación. Sé extremadamente detallado y minucioso.
-
Define con precisión el alcance exacto de la implementación. Determina qué planeas cambiar y qué planeas no cambiar.
-
Revisa el código para verificar la cobertura de pruebas en esta área. Si la cobertura es insuficiente, pregunta al usuario cuáles son sus planes para las pruebas.
-
Divide la implementación en un plan de commits muy pequeños. Recuerda el consejo de Martin Fowler de "hacer cada paso de refactorización lo más pequeño posible, para que siempre puedas ver el programa funcionando".
-
Crea un issue de GitHub con el plan de refactorización. Usa la siguiente plantilla para la descripción del issue:
Declaración del Problema
El problema que enfrenta el desarrollador, desde la perspectiva del desarrollador.
Solución
La solución al problema, desde la perspectiva del desarrollador.
Commits
Un plan de implementación LARGO y detallado. Redacta el plan en lenguaje sencillo, desglosando la implementación en los commits más pequeños posibles. Cada commit debe dejar el código en un estado funcional.
Documento de Decisiones
Una lista de decisiones de implementación que se tomaron. Esto puede incluir:
- Los módulos que se construirán/modificarán
- Las interfaces de esos módulos que se modificarán
- Aclaraciones técnicas del desarrollador
- Decisiones arquitectónicas
- Cambios en el esquema
- Contratos de API
- Interacciones específicas
NO incluyas rutas de archivo específicas ni fragmentos de código. Podrían quedar desactualizados muy rápidamente.
Decisiones de Pruebas
Una lista de decisiones de pruebas que se tomaron. Incluye:
- Una descripción de lo que constituye una buena prueba (solo probar comportamiento externo, no detalles de implementación)
- Qué módulos se probarán
- Arte previo para las pruebas (es decir, tipos similares de pruebas en el código)
Fuera del Alcance
Una descripción de las cosas que están fuera del alcance de esta refactorización.
Notas Adicionales (opcional)
Cualquier nota adicional sobre la refactorización.