Documentação

Execute sua primeira tarefa

Descreva uma tarefa, aprove o plano e veja o Coroid construir e verificar ela.

Uma tarefa é uma unidade de trabalho que resulta em um pull request. Comece uma a partir de Novo trabalho.

Escolha uma boa primeira tarefa

A melhor primeira tarefa é pequena, real e próxima aos testes existentes. Algo como "adicionar uma --json flag ao comando de exportação, correspondendo à forma de saída que o comando de importação já aceita" fornece ao Coroid um alvo claro e lhe dá uma visão nítida do resultado.

Evite, para uma primeira execução:

  • qualquer coisa relacionada a autenticação, pagamentos ou migração de dados
  • trabalho que precise de uma decisão de design ainda não tomada por você
  • limpezas vagas — "melhorar o tratamento de erros" não tem um limite definido

Descreva o que você deseja

Escreva o resultado esperado, não a implementação. Indique o que deve ser verdadeiro quando o trabalho for concluído e mencione tudo que seja não óbvio: arquivos importantes, convenções a seguir, itens que não devem ser alterados.

Você não precisa escrever o plano. Essa é a primeira coisa que o Coroid gera, e você pode aprová-lo.

Se houver contexto que o código não contenha — uma ADR, um guia de estilo, um ticket — anexe-o. Consulte Contexto do projeto para saber o que o Coroid já conhece sem precisar ser informado.

Revise a especificação

O Coroid transforma sua descrição em uma especificação: o que será construído, o que está fora do escopo e os critérios de aceitação que definem o sucesso. Ela aparece na aba Especificações da tarefa.

Leia-a antes que qualquer coisa seja construída. Se os critérios de aceitação não corresponderem ao que você realmente quer, corrija-os agora — eles são o que a fase de verificação testará posteriormente. Consulte Especificações.

Aprove o plano

Para qualquer coisa além de uma alteração trivial, a especificação se torna um plano: um conjunto ordenado de etapas. Você o aprova antes que o código seja escrito.

Este é o momento mais barato para intervir. Rejeitar um plano custa apenas um minuto. Rejeitar um pull request finalizado custa uma execução inteira.

Assista à execução

Após ser aprovada, a tarefa entra em PENDING até que uma vaga de agente esteja disponível, então IN_PROGRESS. Você pode acompanhar a execução em tempo real: as etapas realizadas, ferramentas utilizadas, arquivos alterados e a saída dos testes à medida que são gerados.

Você não precisa assistir. As Notificações informarão quando precisar intervir ou quando a tarefa estiver concluída.

O que esperar

  • A duração é determinada pelo tamanho da alteração e pelo tempo que seu conjunto de testes leva, não pelo número de vagas de agente que você possui. As vagas controlam quantas tarefas rodam ao mesmo tempo.
  • NEEDS_HUMAN_REVIEW não é uma falha. Isso significa que o Coroid encontrou uma decisão que só você pode tomar. Responda e a tarefa continuará.
  • O retrabalho é normal. Se o revisor encontrar algo, a tarefa retorna ao desenvolvedor antes que você a veja.

Próximo

Revise e faça o merge do resultado — o que chega e o que verificar.