CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

review-report

Resumir `.bob/report.md` no corpo do PR. Use ao escrever ou atualizar um pull request depois de `bob check`.

Quality

85%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

review-report

Escrever o corpo do PR no molde Summary / Evidence / Merge Danger. O relatório do bob entra em Evidence e em Merge Danger.

Fonte do formato: docs/SPEC.md. Rode bob check (skill bob-check) antes, para existirem .bob/report.md e .bob/report.json (schema_version: 1).

Quando

  • Escrever o corpo de um PR depois de bob check
  • Atualizar um PR depois de um novo bob check

Interface da CLI

Os comandos abaixo são os que a CLI registra.

bob check   [--base REF] [--gates crap,dry,deps,mutate] [--config bob.yaml] [--format md|json|both] [--out .bob/] [--dry-fail] [--max-new-clones N]
bob crap    [--base REF] [--threshold N] [--coverage-file PATH]
bob dry     [--base REF] [--dry-fail] [--max-new-clones N]
bob deps
bob mutate  [--base REF] [--since-last-run] [--max-workers N]
bob waive   <file::function|Target> --reason "texto de uma linha"
bob doctor  # verifica ferramentas e versões instaladas
  • 0 passou
  • 1 algum gate falhou (limite violado)
  • 2 baseline quebrado (testes falham antes de medir)
  • 3 mutante sobrevivente sem waiver, ou no_coverage nas funções do diff
  • 4 erro de configuração ou ferramenta ausente O 4 é erro de configuração ou ferramenta ausente, ou uso inválido da CLI. Uso inválido: o stderr começa com usage: bob, contém error: e não menciona baseline. Essa execução não grava relatório. Um arquivo .bob/ já presente não é desta execução. Não é o exit 2. A ajuda (-h, --help) sai com 0. Catálogo em docs/exit-codes.md#exit-4.

Passos

  1. Confirmar .bob/report.md. Se a execução que acabou de rodar saiu 4 e o stderr começa com usage: bob, contém error: e não menciona baseline, não escrever o PR a partir do arquivo e não chamar bob check de novo com o mesmo argv. Não é o exit 2. Seguir a skill bob-check. Fora esse caso, se .bob/report.md falta, gerar com bob check --format both. Feito quando .bob/report.md existe e a execução não caiu no uso inválido acima.
  2. Ler o relatório na ordem da spec (abaixo). Feito quando as oito seções foram lidas.
  3. Colocar os vereditos e Onde focar o review em Evidence (antes/depois: último bob check que falhou vs a corrida que passou).
  4. Apontar o caminho .bob/report.md para a página completa. O corpo do PR fica o resumo de uma página.

Conclusão da skill: o PR tem vereditos, a lista de foco e o caminho para .bob/report.md.

Formato do relatório

Lista de docs/SPEC.md (fonte):

  1. Cabeçalho: commit, base, data, versões das ferramentas.
  2. Veredito por gate: ✅ passou / ⚠️ aviso / ❌ falhou / ⏭️ não executado (com motivo).
  3. Onde focar o review: arquivos alterados ordenados por risco (maior CRAP + sobreviventes + clones).
  4. Top 5 funções de maior CRAP no diff (função, arquivo:linha, CC, cobertura, CRAP, delta).
  5. Mutantes sobreviventes (sem waiver = falha) e mutantes sem teste (no_coverage) nas funções do diff, os dois com exit 3, agrupados por função e arquivo, e tabela de waivers com justificativa. Um waiver não cobre no_coverage.
  6. Clones novos (pares, similaridade, linhas).
  7. Violações e ciclos de dependência.
  8. Rodapé: como reproduzir localmente (comando exato).

⏭️ permanece ⏭️, com o motivo.

Molde do corpo do PR

## Summary

<o menor diagrama, árvore ou trecho de diff que mostre o que muda>

## Evidence

- **Before:** <exit e linhas do `bob check` que falhou>
  **After:** <exit `0` e os vereditos atuais>
- **Onde focar o review:** <a lista do relatório>
- <cada waiver, com o id e a justificativa. Diga quando o id é `arquivo::função`, que cobre todo sobrevivente da função>
- Relatório completo: `.bob/report.md`

## Merge Danger

**Door:** <one-way ou two-way. Reverter o PR é a porta de duas vias.>

**Blast Radius:** <uma palavra>

<Gates ❌ e sobreviventes sem waiver aumentam o blast radius. Liste os ⚠️ de clones e cada waiver para o humano julgar.>

Se o repositório já tem um template de PR, use o dele e ponha os mesmos itens nas seções de evidência e de risco.

Repository

fazedordecodigo/bob

Path

skills/review-report/SKILL.md

Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.