O que ai-coding-ironrules faz?
Modelo CLAUDE.md com 11 regras de ferro operacionais para codificação com IA, reutilizável entre projetos.
Regras de Ferro
-
Use nomes descritivos e significativos para variáveis, funções, classes e arquivos. Evite abreviações ou nomes genéricos.
-
Escreva código modular e de baixo acoplamento. Cada função/módulo deve ter uma única responsabilidade bem definida.
-
Adicione comentários apenas quando necessário para explicar o porquê. O código deve ser autoexplicativo; não comente o óbvio.
-
Trate erros de forma explícita e nunca os silencie. Use blocos try-catch ou retorne resultados do tipo Result/Either quando apropriado.
-
Não duplique código. Identifique padrões e extraia funções/classes reutilizáveis. Siga o princípio DRY (Don't Repeat Yourself).
-
Priorize a legibilidade e a simplicidade. Código mais curto nem sempre é melhor; prefira clareza a complexidade desnecessária.
-
Mantenha as funções pequenas. Se uma função exceder 20-30 linhas, considere dividi-la em funções menores.
-
Documente APIs e interfaces públicas com comentários de documentação (ex.: JSDoc, docstrings Python). Explique parâmetros, retorno e exceções.
-
Utilize versionamento semântico e mensagens de commit significativas. Siga convenções como Conventional Commits.
-
Nunca inclua segredos, chaves de API ou credenciais no código. Use variáveis de ambiente e provedores de secrets.
-
Teste seu código de forma automatizada. Escreva testes unitários para toda a lógica de negócio; mantenha cobertura acima de 80%.
Como usar
- Copie este arquivo como
CLAUDE.mdpara a raiz do seu projeto. - Adapte as regras conforme necessário para o seu contexto (linguagem, framework, time).
- O agente de IA (Claude Code, Cursor, Codex) lerá automaticamente este arquivo e seguirá as regras.
Nota: Este é um template. Sinta-se à vontade para adicionar ou remover regras baseado nas necessidades do seu projeto.
Contribuição
Pull requests são bem-vindos! Se você tem sugestões de novas regras ou melhorias, abra um issue ou PR.