O CI (Continuous Integration) é uma prática crucial no desenvolvimento de software, onde os códigos são integrados e testados frequentemente. No entanto, a validação de mudanças no CI pode ser confusa sem um registro claro e detalhado do motivo por trás dessas alterações. Este guia aborda como registrar a motivação por trás das mudanças no CI de forma eficaz e prática.
Identificando a Origem das Mudanças
O primeiro passo é identificar a origem das mudanças no CI. Isso pode ser feito através de um processo de inspeção do código, onde o revisor pode identificar o ticket ou pedido que originou a alteração. Além disso, é importante verificar quais arquivos e fluxos foram afetados pela mudança.
Exemplo Hipotético
Suponha que um agente alterou a validação de um formulário, fazendo com que um campo antes opcional passe a ser obrigatório. O CI agora está verde, indicando que a mudança foi bem sucedida. No entanto, o revisor pode precisar de mais informações para entender por que essa mudança foi feita. O ticket, o diff e os resultados dos testes são essenciais para fornecer essa informação.
Descrevendo o Motivo da Mudança
O próximo passo é descrever o motivo da mudança. Isso pode ser feito através de um recibo curto, que pode ser um comentário no PR, uma seção do template ou um campo no artefato de revisão. O recibo deve incluir informações como qual ticket ou pedido originou a alteração, qual comportamento deve existir após a mudança, quais arquivos e fluxos foram afetados, quais alternativas foram descartadas e por quê, e quem confere a lacuna e assume a aprovação.
Exemplo de Recibo
Um recibo curto poderia ser algo como: 'O ticket #123 solicitou que o campo 'nome' passe a ser obrigatório. O comportamento esperado é que o campo seja verificado e uma mensagem de erro seja exibida se não for preenchido. O campo 'nome' estava antes opcional. Não foi executado nenhum teste de persistência para garantir que o valor permaneça após recarregar a página. O revisor deve verificar se a implementação está de acordo com o comportamento esperado e confirmar se o valor persiste após recarregar a página.'
Melhorando a Informação para a Revisão
Para facilitar a revisão, é importante melhorar a informação que chega ao revisor. Isso pode ser feito através de um recibo curto que inclui informações relevantes, como o ticket, o diff e os resultados dos testes. Se um teste não foi executado, é importante explicar o motivo.
Conclusão
Registrar a motivação por trás das mudanças no CI é essencial para a revisão eficaz. Isso requer um registro claro e detalhado do motivo por trás das mudanças, incluindo informações sobre o ticket, o diff e os resultados dos testes. Ao melhorarmos a informação que chega ao revisor, podemos facilitar a revisão e permitir que outra pessoa entenda a mudança e tenha condições reais de aprová-la.
Referências
- Anúncio do forge e dos Trails da Entire
- Preprint que examina funções do PR e alternativas discutidas em documentos públicos.