Como usar Kody Rules para criar e importar regras

As Kody Rules são como leis internas para o seu repositório. Elas permitem que a Kody aplique padrões de código, segurança e boas práticas de forma automática durante o code review. Essas regras podem ir desde padrões de nomenclatura, como componentes React devem estar em PascalCase, até requisitos críticos de negócio, como operações de pagamento devem ser idempotentes. Ao criar regras claras, você reduz inconsistências, acelera revisões e evita que problemas recorrentes se repitam. Se o seu time já segue padrões bem definidos, as Kody Rules garantem que eles sejam aplicados de forma consistente. Se ainda não há um padrão formal, a Rules Library pode ser o ponto de partida para criar o seu.

Acessando o painel de Kody Rules

Para visualizar, criar ou editar regras:

1. Vá até o painel da Kodus → Code Review Settings →  Kody Rules.

Se for a primeira vez que acessa, você verá algumas regras criadas automaticamente pela Kody. Elas são um bom ponto de partida, mas o valor real está em criar ou importar regras específicas para o seu contexto. 💡 Por que isso importa: começar com as regras certas desde o início do trial ajuda a Kody a gerar feedback relevante já nos primeiros PRs.

Criando uma regra personalizada

Ao clicar em Nova Regra, você precisa escolher o escopo:

• File: para regras que se aplicam a arquivos ou pastas específicas.

• Pull Request: para regras que se aplicam ao PR como um todo, incluindo título, descrição e conjunto de mudanças. Nesse caso, o campo Path é desativado, pois a regra não foca em arquivos específicos.

💡 Dica rápida:

– Se a regra é sobre o que está sendo alterado → File.
– Se é sobre como a alteração está sendo feita → Pull Request.

Instruções

O campo Instruções é onde você descreve de forma clara e objetiva o que a Kody deve observar durante o code review.

É aqui que você traduz o padrão que o time quer seguir em um texto que a Kody possa interpretar e aplicar de forma consistente.

Uma boa instrução deve:

• Explicar o que precisa ser feito ou evitado.

• Incluir detalhes técnicos relevantes.

• Ser curta e direta, para que qualquer pessoa do time entenda sem precisar de mais contexto.

💡 Quanto mais específica, mais precisa será a detecção da Kody e mais claro ficará o comentário no PR.

Por exemplo: Essa descrição deixa claro o objetivo da regra (evitar duplicidade de cobrança) e a técnica a ser aplicada (uso de idempotency keys), permitindo que tanto a Kody quanto o desenvolvedor entendam o motivo por trás da verificação.

Escolhendo a severidade da regra

A Severity define a prioridade dessa regra durante o code review e a probabilidade dela aparecer para o desenvolvedor.

Regras mais severas tendem a ser exibidas com mais destaque e frequência.

Use a seguinte lógica para decidir:

• Low: impacto mínimo, apenas para recomendações sutis ou de estilo.

• Medium: importância moderada, quando a prática é desejada mas não crítica.

• High: prioridade alta, deve aparecer com frequência quando a violação ocorrer.

• Critical: prioridade máxima, usada para problemas que podem gerar falhas graves, riscos de segurança ou impacto direto no negócio.

💡 Se nenhuma severidade for escolhida, o padrão é High.

Incluindo exemplos bons e ruins

A Kody entende melhor suas regras quando você fornece um Bad Example e um Good Example. Isso evita interpretações ambíguas e melhora a qualidade das sugestões. 📌 Exemplo 💡 Importante: use exemplos próximos do seu código real. Isso ajuda a Kody a ser mais precisa e o seu time a entender mais rápido.

Usando a Rules Library

A Rules Library é uma coleção de regras prontas que a Kody disponibiliza para aplicar no seu repositório com um clique. São boas práticas testadas e validadas por outros times, cobrindo desde padrões de código até regras de segurança, performance e manutenibilidade. Ela é um ótimo ponto de partida se o seu time ainda não tem boas práticas definidas, porque ajuda a criar essa base sem começar do zero. E se o seu time já segue padrões, a biblioteca pode complementar com ideias novas e reforçar áreas que talvez não estejam formalizadas. Como funciona:

1. No painel da Kodus, vá para Discovery Rules.
2. Filtre por severidade, linguagem ou tags para encontrar o que faz sentido para o seu contexto.
3. Abra a regra para ver detalhes, instruções e exemplos.
4. Gostou? Ative com um clique e a Kody começa a aplicá-la nos seus PRs.

Exemplos do que você vai encontrar:

• Segurança: “Proibir uso de hash MD5 inseguro.”
• Manutenibilidade: “Limitar componentes React a menos de 150 linhas.”

Mesmo que seu time já siga padrões definidos, sempre vale dar uma olhada. É comum encontrar ideias de regras que fortalecem ainda mais o seu processo de review.