Communitygithub.com

Gary06868/repo-proof

Torne seu README verdadeiro com relatórios de evidência baseados em clones limpos.

O que é repo-proof?

Esta skill permite que um agente de IA audite e prove que as instruções de um repositório (como instalação, execução, teste e demonstração) funcionam a partir de um clone limpo. Ela é útil para desenvolvedores que desejam garantir que seus READMEs e scripts de release sejam precisos e confiáveis, tratando o README como um contrato com o usuário. A skill gera relatórios de evidência, classifica falhas (em README, scripts, configuração ou pacotes) e pode sugerir correções mínimas. Suporta automação via GitHub Action para verificação contínua da verdade do README. O fluxo de trabalho começa com uma auditoria segura (sem executar código do repositório) e, com permissão explícita, pode executar os passos para provar o funcionamento, sempre seguindo regras rígidas de segurança.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add Gary06868/repo-proof

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação


name: repo-proof description: Use esta skill quando um usuário precisar provar que o README de um repositório ou instruções de release funcionam a partir de um clone limpo: auditar etapas de instalação/execução/teste/demo, criar relatórios de evidência em ambiente controlado, classificar falhas de README/script/config/pacote, gerar correções mínimas ou adicionar uma GitHub Action para verificação da verdade do README. Não use para escrita comum de README, revisão genérica de código, listas de verificação amplas de QA ou tarefas que não exijam evidências baseadas em clones limpos do repositório.

RepoProof

Prove o repositório do ponto de vista de um novo usuário. Trate o README como um contrato, não como uma sugestão.

Fluxo de Trabalho Padrão

  1. Execute node scripts/repoproof.mjs audit . --output repoproof-output.
  2. Leia repoproof-output/repoproof-report.json antes de tirar conclusões.
  3. Se o usuário permitir explicitamente a execução, execute node scripts/repoproof.mjs prove . --allow-exec --output repoproof-output.
  4. Se forem solicitadas correções, execute node scripts/repoproof.mjs fix . --dry-run --output repoproof-output e inspecione repoproof-fixes.patch.
  5. Relate apenas o que as evidências suportam. Marque alegações não comprovadas como não comprovadas.

Regras de Segurança

  • O modo de auditoria é o padrão e não deve executar código do repositório.
  • O modo de prova requer aprovação explícita do usuário com --allow-exec ou um executor de CI.
  • Nunca publique, implante, envie, mescle ou leia segredos do usuário.
  • Nunca afirme isolamento forte sem um contêiner real, VM ou sandbox de SO.
  • Use scripts determinísticos para coleta e ocultação de evidências.

Referências

  • Leia references/workflow.md para o fluxo de trabalho completo de auditoria/prova/correção.
  • Leia references/safety-model.md antes de executar código do repositório.
  • Leia references/extraction-rules.md quando a extração de etapas do README for ambígua.
  • Leia references/fix-policy.md antes de propor edições.
  • Leia references/evidence-schema.md ao interpretar relatórios.
  • Leia references/github-action.md antes de adicionar CI.
  • Leia references/platform-notes.md para diferenças entre Windows, macOS e Linux.

Habilidades Relacionadas