rodri-oliveira-dev Objetivo
Manter a documentacao das regras consistente com o comportamento real dos analyzers, sem prometer heuristicas, configuracoes ou garantias que nao existem no codigo.
Quando usar
Use esta skill quando a tarefa envolver:
- novo arquivo
docs/rules/<grupo>/<ID>.md; - ajuste de comportamento documentado;
- exemplos conformes e nao conformes;
- documentacao de configuracoes por
.editorconfig; - atualizacao da tabela de regras no
README.md.
Estrutura recomendada
Cada regra deve conter, quando aplicavel:
- Titulo com ID e resumo.
- Objetivo.
- Codigo nao conforme.
- Codigo conforme.
- Configuracao.
- Heuristica.
- Limitacoes conhecidas.
- Impacto esperado.
Regras de escrita
- Documente apenas comportamento implementado.
- Seja claro sobre o que a regra nao valida.
- Use o mesmo ID, titulo e semantica do
DiagnosticDescriptor. - Quando a regra aceitar
.editorconfig, mostre chaves e valores aceitos. - Quando houver fallback de configuracao, documente o fallback.
- Atualize o README se mudar lista de regras, severidade, categoria, nome publico ou configuracao publica.