From 1c5bf163e11e8249aa05e80ec784fbd2fae22609 Mon Sep 17 00:00:00 2001 From: Cleber Rangel Date: Wed, 12 Aug 2026 12:17:47 -0300 Subject: [PATCH] =?UTF-8?q?docs:=20alinhar=20preview=20de=20escopo=20e=20c?= =?UTF-8?q?r=C3=A9ditos=20OCR=20nos=20READMEs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.en.md | 17 +++++++++-------- README.md | 28 ++++++++++++++++------------ 2 files changed, 25 insertions(+), 20 deletions(-) diff --git a/README.en.md b/README.en.md index 52b28e9..854ace8 100644 --- a/README.en.md +++ b/README.en.md @@ -399,14 +399,15 @@ With the level announced, it creates the cleanup branch and proceeds: explicit **Preview (phase 1.3)** into `CLEANUP_PROGRESS.md` — the concrete deps, files and exports the report would remove — and commits that log update alone (`chore: preview phase 1 deletions`). On GREEN it proceeds - without asking after that record exists; on YELLOW the preview simply omits - what the level will not touch. Each delete step stages only pathspecs of - that step's artifacts (`git add -- …`, never `git add -A`), and only lands - with a green gate. At the end, phase **1.4** produces a full audit; every - unit in the sweep ends `reviewed` or `skipped` with a reason, and the - counts plus `coverage_rate` land under `## Coverage` in the progress log — - a rate below 100% without a recorded Decisions gap leaves the step - incomplete. + without asking after that record exists; on YELLOW (or any stack cap) the + preview omits what the level will not touch **and** what the user scoped + out — scoped-out categories still get a Decisions line. Each delete step + stages only pathspecs of that step's artifacts (`git add -- …`, never + `git add -A`), and only lands with a green gate. At the end, phase **1.4** + produces a full audit; every unit in the sweep ends `reviewed` or + `skipped` with a reason, and the counts plus `coverage_rate` land under + `## Coverage` in the progress log — a rate below 100% without a recorded + Decisions gap leaves the step incomplete. - **Phase 1.5 — duplicate functions** (closes phase 1). Sweeps for functions with different names doing the same thing (similarity-ts or fallow on JS/TS, jscpd on other stacks) and applies the churn rule: a pair that diff --git a/README.md b/README.md index 15b83ed..01a79ad 100644 --- a/README.md +++ b/README.md @@ -412,14 +412,15 @@ Com o nível anunciado, ela cria a branch de limpeza e segue: usadas, arquivos órfãos, exports mortos. Antes da primeira mutação da fase 1.3, grava um **preview** em `CLEANUP_PROGRESS.md` (lista concreta por categoria, commit próprio `chore: preview phase 1 deletions`) — no - GREEN segue sozinha depois desse registro; no YELLOW o preview só omite o - que o nível já proíbe. Cada passo faz stage só com pathspecs dos - artefatos daquele passo (`git add -- …`, nunca `git add -A`), e só entra - com gate verde. No fim, produz uma auditoria do que sobrou (fase 1.4), - com **coverage mandate**: cada unidade da varredura fecha como - `reviewed` ou `skipped` com motivo, e o `coverage_rate` vai no log — - taxa abaixo de 100% sem gap registrado em Decisions deixa o passo - incompleto. + GREEN segue sozinha depois desse registro; no YELLOW (ou sob cap de + stack) o preview omite o que o nível já proíbe **e** o que o usuário + tirou de escopo — categorias fora do escopo do usuário ainda entram em + Decisions. Cada passo faz stage só com pathspecs dos artefatos daquele + passo (`git add -- …`, nunca `git add -A`), e só entra com gate verde. + No fim, produz uma auditoria do que sobrou (fase 1.4), com **coverage + mandate**: cada unidade da varredura fecha como `reviewed` ou `skipped` + com motivo, e o `coverage_rate` vai no log — taxa abaixo de 100% sem + gap registrado em Decisions deixa o passo incompleto. - **Fase 1.5 — funções duplicadas** (fecha a fase 1). Varre funções com nomes diferentes fazendo a mesma coisa (similarity-ts ou fallow em JS/TS, jscpd nos demais stacks) e aplica a regra do churn: par que muda junto no git é @@ -579,13 +580,16 @@ Skills e materiais usados na construção desta: Ferramenta complementar (opcional, sem vendoring): - [OpenCodeReview](https://github.com/alibaba/open-code-review) (Alibaba, - Apache-2.0) — CLI de review de diff/PR que a documentação desta skill - pode citar como passo opcional depois da branch `cleanup/`. Não entra no - runtime; a receita está em `references/complementarity-opencodereview.md`. + Apache-2.0) — não embutido aqui; a disciplina de review dele (preview + antes do gasto, checklists de cobertura, severidade nos achados) informou + as seções nomeadas de preview, coverage mandate e residual-risks deste + protocolo. A documentação pode citar o CLI como passo opcional depois da + branch `cleanup/`; a receita fica em + `references/complementarity-opencodereview.md`. Nenhuma delas é dependência de runtime: são fontes e ferramentas de desenvolvimento — nada além desta pasta precisa estar instalado para usar a -codebase-cleanup. +codebase-cleanup. O OCR permanece opcional e externo se você quiser rodá-lo. ## Licença