Skip to content

Criar o teu próprio pack

Os packs de regras são markdown simples, por isso adicionar ou melhorar um é fácil.

Adicionar um pack

  1. Cria rules/<id>.md com uma lista de regras. Mantém cada regra curta, concreta e no imperativo ("Faz X", "Nunca Y").
  2. Regista-o em src/packs.ts:

export const PACKS = [
  // …existentes…
  { id: 'docs', title: 'Documentação', description: 'Manter docs em sincronia com o código.', file: 'docs.md' },
] as const;
3. Acrescenta uma expetativa de teste se fizer sentido e corre npm test.

Pronto — composeRules(['docs']) e agent-rules-kit init --packs docs já funcionam.

Escrever boas regras

  • Uma ideia por bullet. Os assistentes seguem melhor regras curtas e inequívocas.
  • Diz o que fazer e o que não fazer. "Validar input na fronteira" é melhor que "ter cuidado".
  • Evita especificidades do projeto nos packs partilhados — essas pertencem às tuas adições ao AGENTS.md, não ao kit.
  • Explica o porquê só quando muda o comportamento. Mantém conciso.

Adições específicas do projeto

Gera o ficheiro base e depois acrescenta as especificidades do teu repo (arquitetura, comandos, convenções) abaixo das secções geradas. Correr init sobrescreve o ficheiro, por isso mantém as notas específicas num ficheiro à parte ou num bloco bem marcado que voltas a acrescentar.

Contribuir packs

Regras boas e amplamente aplicáveis são bem-vindas upstream — abre um PR a editar rules/ e src/packs.ts. Ver CONTRIBUTING.