Visão Geral
A Validação de Regras de Negócio permite confirmar que um pull request implementa o comportamento esperado descrito em uma especificação, documento ou ticket. Kody analisa o diff do PR, incorpora o contexto de negócio referenciado e sinaliza divergências antes do merge.
Pré-requisitos
- Se você deseja que Kody busque automaticamente o contexto da tarefa de ferramentas como Jira, Linear, Notion ou ClickUp, o plugin correspondente deve estar conectado na página de Plugins do seu workspace.
- Qualquer link que você compartilhar (Jira, Slack, Google Docs, etc.) deve estar acessível pelos plugins instalados no seu workspace.
- Você sempre pode fornecer a especificação diretamente sem nenhum plugin — basta colar os requisitos no comentário do PR.
Habilitando a Validação de Regras de Negócio
A Validação de Regras de Negócio está habilitada por padrão. Você pode controlá-la de duas formas: Viakodus-config.yml:
Execução Sob Demanda
Você também pode acionar a validação manualmente a qualquer momento:- Abra a caixa de comentário principal do PR (fora das sugestões de código inline).
- Mencione Kody e adicione o comando de validação:
@kody -v business-logic .... - Forneça o conteúdo da especificação diretamente ou cole um link que Kody possa buscar via plugins disponíveis.
- Envie o comentário e aguarde a resposta de Kody na mesma thread.
Exemplos
- Ticket Jira:
@kody -v business-logic https://kodustech.atlassian.net/jira/software/c/projects/KC/boards/2?selectedIssue=KC-1292 - Issue Linear:
@kody -v business-logic https://linear.app/your-team/issue/TEAM-123 - Página Notion:
@kody -v business-logic https://www.notion.so/your-workspace/Feature-Spec-abc123 - Google Doc:
@kody -v business-logic https://docs.google.com/document/d/1234567890/edit - Conversa Slack:
@kody -v business-logic https://kodustech.slack.com/archives/C070E5E97DE/p1727814000000000 - Trecho de spec inline:
@kody -v business-logic Regra XYZ — pedidos acima de R$500 devem emitir créditos de cashback.
O Que Kody Faz
- Busca o diff do PR e os metadados do pull request.
- Recupera o contexto da tarefa — da ferramenta de gestão de tarefas vinculada (Jira, Linear, etc.) ou do texto inline fornecido.
- Classifica a qualidade do contexto da tarefa — determina a profundidade da análise com base nas informações disponíveis.
- Compara a implementação com os requisitos — verifica cada critério de aceite em relação ao diff do PR.
- Reporta os achados com níveis de severidade e rastreabilidade dos requisitos.
Qualidade do Contexto da Tarefa
Kody classifica automaticamente a qualidade do contexto da tarefa antes da análise, o que afeta a profundidade da validação:| Qualidade | Descrição | Comportamento da Análise |
|---|---|---|
| Completo | Tem título, descrição e critérios de aceite | Análise critério a critério completa |
| Parcial | Tem título e descrição, mas sem critérios de aceite | Análise de melhor esforço com base no comportamento descrito |
| Mínimo | Tem apenas um título ou descrição muito curta | Conservador — sinaliza apenas lacunas óbvias |
| Vazio | Nenhum contexto de tarefa significativo encontrado | Retorna uma resposta “Preciso de Informações da Tarefa” |
Entendendo o Resultado
Severidades dos Achados
Cada achado inclui um nível de severidade:- MUST_FIX — Uma regra de negócio obrigatória não foi implementada, está incorreta ou contradiz os requisitos da tarefa
- SUGGESTION — Um caso de borda relevante, ponto de robustez ou manutenibilidade não está coberto
- INFO — Observação útil que não bloqueia a conformidade
Achados Rastreáveis
Cada achado é rastreável a um requisito específico do contexto da tarefa. Cada achado inclui:- Requisito — A citação exata da tarefa que estabelece o requisito
- Ausente no código — O que está faltando ou incorreto no diff do PR
- Ação sugerida — Uma ação de implementação concreta
Detecção de Divergência de Escopo
Se o diff do PR parece estar trabalhando em um domínio diferente da própria tarefa, Kody detecta isso como uma divergência de escopo e a reporta como o achado principal, em vez de produzir uma análise de lacunas enganosa.Exemplo de Resultado
Dicas
- Divida especificações grandes em seções e valide-as individualmente para manter o feedback focado.
- Ao compartilhar links privados, verifique se o plugin necessário (ex.: Jira, Slack, Google Drive) está instalado e autorizado para o seu workspace.
- Após resolver os achados, execute o comando novamente para confirmar que o PR está alinhado com as regras de negócio.
- Forneça critérios de aceite na sua tarefa para a análise mais completa — tarefas com critérios explícitos recebem validação critério a critério.