Pular para o conteúdo principal

Visão geral

Colocar um novo time em funcionamento com o Kodus leva cerca de 30 minutos. Este guia percorre a configuração completa para que seu time extraia valor desde o primeiro PR.

Passo 1 — Crie e configure o workspace

  1. Cadastre-se em kodus.io ou acesse sua instância auto-hospedada
  2. Crie um novo workspace para o seu time
  3. Conecte seu provedor Git (GitHub, GitLab, Bitbucket, Azure Repos ou Forgejo)
  4. Selecione os repositórios a monitorar

Passo 2 — Defina a linha de base de revisão

Comece com padrões sensatos antes de personalizar:
Isso fornece revisões automatizadas com um limite de severidade razoável. Ajuste após uma semana com base no feedback.

Passo 3 — Use as instruções que você já escreveu para agentes de código

Se o seu time já mantém instruções do Cursor, Copilot, Claude ou AGENTS.md:
  1. Na barra lateral, selecione Global ou um repositório no seletor de escopo no topo do grupo Code review, abra What to review e ative Coding-agent instructions
  2. O Kody lê os arquivos de instrução que cobrem os arquivos alterados em cada pull request e aponta mudanças que os quebram
  3. Para uma convenção que você quer aplicar em toda revisão, escreva-a como um arquivo de regra em .kody/rules
Os arquivos de instrução nunca são transformados em Kody Rules, então não podem mudar sua política de revisão sem que você perceba.

Passo 4 — Ensine suas 5 principais convenções

Não tente codificar tudo no primeiro dia. Comece com as 5 convenções sobre as quais seu time mais discute:
Estas se tornam Memories que se aplicam imediatamente a todas as revisões.

Passo 5 — Crie 2-3 regras críticas

Adicione regras para coisas que nunca devem acontecer:

Passo 6 — Conecte a gestão de tarefas (opcional, mas recomendado)

Conecte Jira, Linear, Notion ou ClickUp em Plugins (na barra lateral) para habilitar a validação de lógica de negócio. Isso permite que o Kodus verifique se os PRs implementam o que as tarefas descrevem.

Passo 7 — Execute um PR piloto

Abra um PR de teste e verifique:
  • Os comentários do Kodus aparecem no PR
  • As sugestões são relevantes e com a severidade correta
  • Suas regras personalizadas disparam quando deveriam
  • As Memories são refletidas no contexto de revisão

Passo 8 — Colete feedback após uma semana

Após uma semana de revisões, consulte o time:
  • Há sugestões demais? → Aumente Minimum severity to post em Code review → What to review (severityLevelFilter no kodus-config.yml)
  • As regras estão gerando muito ruído? → Restrinja os caminhos de arquivo ou adicione exclusões
  • Faltam padrões importantes? → Adicione novas regras ou Memories
  • Quer regras geradas automaticamente? → Selecione o repositório no seletor de escopo, abra Code review → Kody Rules, clique em Configuration e ative Generate from past reviews para obter sugestões do histórico de revisões

Dicas

  • Não sobrecarregue com regras no primeiro dia — comece pequeno e expanda
  • Deixe o time ensinar o Kody naturalmente por meio de conversas antes de formalizar como regras
  • Use @kody start-review nos primeiros PRs para que o time veja o Kodus em ação
  • Ative Kody knowledge approval (Code review → Kody Rules → Configuration) se quiser revisar o que o Kody aprende
Para o guia completo de configuração, consulte Início Rápido.