Esta skill será invocada quando o usuário quiser criar uma solicitação de refatoração. Você deve seguir as etapas abaixo. Você pode pular etapas se não as considerar necessárias.
-
Peça ao usuário uma descrição longa e detalhada do problema que ele deseja resolver e quaisquer ideias potenciais para soluções.
-
Explore o repositório para verificar suas afirmações e entender o estado atual da base de código.
-
Pergunte se ele considerou outras opções e apresente outras opções a ele.
-
Entreviste o usuário sobre a implementação. Seja extremamente detalhado e minucioso.
-
Defina exatamente o escopo da implementação. Trabalhe para determinar o que você planeja alterar e o que planeja não alterar.
-
Verifique na base de código a cobertura de testes desta área. Se a cobertura de testes for insuficiente, pergunte ao usuário quais são seus planos para testes.
-
Divida a implementação em um plano de commits minúsculos. Lembre-se do conselho de Martin Fowler: "torne cada etapa de refatoração o menor possível, para que você possa sempre ver o programa funcionando".
-
Crie um issue no GitHub com o plano de refatoração. Use o seguinte modelo para a descrição do issue:
Declaração do Problema
O problema que o desenvolvedor está enfrentando, da perspectiva do desenvolvedor.
Solução
A solução para o problema, da perspectiva do desenvolvedor.
Commits
Um plano de implementação LONGO e detalhado. Escreva o plano em inglês simples, detalhando a implementação nos menores commits possíveis. Cada commit deve deixar a base de código em um estado funcional.
Documento de Decisão
Uma lista de decisões de implementação que foram tomadas. Isso pode incluir:
- Os módulos que serão construídos/modificados
- As interfaces desses módulos que serão modificadas
- Esclarecimentos técnicos do desenvolvedor
- Decisões arquiteturais
- Alterações de esquema
- Contratos de API
- Interações específicas
Não inclua caminhos de arquivo específicos ou trechos de código. Eles podem ficar desatualizados muito rapidamente.
Decisões de Teste
Uma lista de decisões de teste que foram tomadas. Inclua:
- Uma descrição do que constitui um bom teste (testar apenas comportamento externo, não detalhes de implementação)
- Quais módulos serão testados
- Artefatos anteriores para os testes (ou seja, tipos semelhantes de testes na base de código)
Fora do Escopo
Uma descrição das coisas que estão fora do escopo desta refatoração.
Notas Adicionais (opcional)
Quaisquer notas adicionais sobre a refatoração.