Integração de um novo time

​

Visão geral

​

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

# kodus-config.yml — coloque este arquivo na raiz de cada repositório
reviewOptions:
  bug: true
  security: true
  performance: true
  business_logic: true

suggestionControl:
  severityLevelFilter: medium
  applyFiltersToKodyRules: false

automatedReviewActive: true

​

Passo 3 — Importe regras existentes de ferramentas de IDE

1. Na barra lateral, selecione o repositório no seletor de escopo no topo do grupo Code review, abra Kody Rules, clique em Configuration e ative Auto-sync rules from repo
2. O Kodus detecta arquivos .cursorrules, .github/copilot-instructions.md e .claude
3. Revise as regras importadas e mantenha as que fazem sentido para revisão de código

​

Passo 4 — Ensine suas 5 principais convenções

@kody remember: we use camelCase for variables and PascalCase for types.

@kody remember: all API responses use the standard envelope format
{ data, error, meta }.

@kody remember: we prefer composition over inheritance.
Use interfaces and dependency injection.

@kody remember: every public function must have JSDoc with
@param and @returns descriptions.

@kody remember: database queries go through the repository layer only.
No direct DB access from services or controllers.

​

Passo 5 — Crie 2-3 regras críticas

Name: No console.log in production code
Execution mode: Per file
Path: src/**/*.ts
Severity: High
Instructions: Flag any console.log, console.warn, or console.error
in fileDiff. Use the project logger instead.
Exclude test files (*.spec.ts, *.test.ts).

Name: No hardcoded API URLs
Execution mode: Per file
Path: src/**/*.ts
Severity: Critical
Instructions: Flag any hardcoded URL (http:// or https://)
in fileDiff that looks like an API endpoint.
URLs must come from environment variables or config files.

​

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

​

Passo 7 — Execute um PR piloto

• 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

• 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