Pular para o conteúdo principal
As Regras do Repositório estão sempre sincronizadas: não há configuração para ativar. Elas são os únicos arquivos de um repositório que viram Kody Rules. Instruções escritas para agentes de código (CLAUDE.md, AGENTS.md, .cursor/rules) são tratadas à parte, veja Instruções para Agentes de Código.

Como Usar

Você pode criar Kody Rules personalizadas diretamente no seu repositório colocando arquivos markdown estruturados em diretórios específicos. Isso permite versionar suas regras junto com o código e compartilhá-las com toda a equipe.
Arquivos de regras do repositório são importados verbatim — sem conversão por LLM. O frontmatter é parseado como está, o corpo markdown vira as instruções da regra exatamente como você escreveu (identificadores, formatação e texto preservados), e os exemplos Bad/Good são importados estruturalmente. Cada arquivo produz uma regra. Um arquivo que não segue o template (sem frontmatter, title ou corpo) é ignorado, e a sincronização registra isso no log; nada é gerado a partir dele.

Sincronização

  • Detecção Automática: As regras do repositório são detectadas e sincronizadas em todo repositório conectado; não há nada para habilitar
  • Importar agora: No painel Kody Rules → Configuration do repositório, Import rule files now lê todos os arquivos de regras da branch padrão
  • Aplicação Web: As regras sincronizadas aparecem na página Code review → Kody Rules do repositório, com a origem Auto-sync (regras importadas de arquivos de agentes de código antes de pararem de ser convertidas mostram Agent file)
  • Atualizações em Tempo Real: As alterações nos arquivos de regras são sincronizadas quando Pull Requests são mesclados na branch padrão

Localização dos Arquivos

Coloque seus arquivos de regras em um destes diretórios, na raiz do repositório ou em qualquer subdiretório:
  • .kody/rules/**/*.md
  • rules/**/*.md
  • .rules/** e docs/coding-standards/** (apenas arquivos que seguem o template)

Template de Regra

Cada arquivo de regra deve seguir exatamente esta estrutura de template:

Campos do Template

Campos Obrigatórios

Só duas coisas são estritamente obrigatórias: um title não vazio e um corpo de regra não vazio. Um arquivo sem um dos dois é ignorado por completo.

Campos com valor padrão

Todo o resto é opcional — se omitir, vale o padrão.
severity é aceito como alias de severity_min, já que é um erro fácil de digitar e a intenção é inequívoca. Qualquer valor fora dos quatro níveis cai para "medium", e qualquer scope diferente de "pull-request" é tratado como "file".

Exemplos de Regras

Exemplo de Regra no Nível de Arquivo

Exemplo de Regra no Nível de Pull Request

Requisitos de Configuração

  1. Criar arquivos de regras: Coloque arquivos .md que seguem o template em .kody/rules/** ou rules/**. Arquivos em .rules/** e docs/coding-standards/** que seguem o template também são importados.
  2. Fazer o merge: Um arquivo de regra sincroniza quando um Pull Request que o adiciona, altera, renomeia ou remove é mesclado na branch padrão. Remover o arquivo remove a regra correspondente.
  3. Arquivos existentes: Para importar arquivos de regras que já estão na branch padrão, use Import rule files now no painel Kody Rules → Configuration do repositório.
Novas regras entram ativas, ou em Pending review quando Kody knowledge approval está ativado.
Adicione @kody-ignore em qualquer lugar de um arquivo de regra para mantê-lo no repositório sem sincronizá-lo. A regra existente dele é removida na próxima sincronização.

Verificando sincronização e avaliação de regras (self-hosted)

Em deployments self-hosted, os logs da API carregam marcadores grep-áveis para debug:
  • [kody-rules-sync] — sumário por execução de sync: quais arquivos foram importados, pulados (com o motivo) ou removidos.
  • [kody-rules-eval] — trace de avaliação por arquivo durante um review: exatamente quais regras (uuid + título) foram selecionadas para o prompt de cada arquivo revisado.
Se uma regra aparece como ativa na UI mas nunca aparece em [kody-rules-eval] para os arquivos esperados, verifique o glob do campo Path — uma regra só roda em arquivos que casam com o path.

Limites de regras

Organizações no plano Free da cloud (ou cuja assinatura foi cancelada ou expirou) e instâncias self-hosted rodando sem licença válida (Community Edition) avaliam no máximo 10 regras ativas por review (as mais antigas primeiro). Regras além do limite continuam na lista como Locked e são puladas em todo PR; um banner em Code review → Kody Rules informa quantas estão sendo puladas. Planos pagos da cloud e instâncias self-hosted licenciadas não têm esse limite. Se regras além da 10ª não disparam, esse limite é o motivo.