Repository navigation
Docs/preparacao para divulgacao - #42
Merged
Merged
Conversation
O bloco mostrava `discover --schema public` acima de um transcript cuja segunda linha diz "full validation — every row was examined". Sem `--full`, essa linha sai como "sampled mode (100000 rows/table target), but every table fit the target and was read whole": o demo tem tabelas pequenas, então o método acaba sendo full de qualquer jeito, mas o texto do relatório é outro. O `make demo-svg` e o `demo/compose.yaml` sempre passaram `--full` — a gravação está certa, o comando ao lado dela é que estava incompleto.
Os dois estavam carimbados `v0.1.2` com a v0.2.0 publicada. Regravados pelo caminho do `make demo-svg` — binário construído na tag mais recente, Postgres 16 descartável, `demo/schema.sql`, `discover --schema public --full` — e não editados à mão. A gravação mudou em dois tokens, versão e duração, o que de quebra confirma que a mudança da penalidade de nome genérico não altera este schema: ele não tem nenhuma coluna com nome genérico apontando para tabela pequena, então o sinal nunca é emitido aqui.
O recall estava na linha 439, e o único número acima dele era "around 61%" — o mais fraco dos quatro, dentro de um aviso. Quem decide em quinze segundos se vai ler o resto nunca chegava no 84,9%, e o 84,9% é a demonstração mais curta que o projeto tem de por que a detecção de convenção existe. Os quatro números sobem juntos, de propósito: 62,6% e 61,5% no GitLab, 84,9% e 16,6% no schema municipal. Publicar só o 84,9% seria escolher o número conveniente, que é exatamente o que este README passa a seção de medição inteira dizendo que não faz. O par é mais forte que a metade boa dele. O aviso perde a frase de recall, agora redundante, e ganha a informação de que a imagem é gravada da saída real pelo `make demo-svg`. A navegação passa a listar Prior art e o guia em `docs/guide/`.
…xistir A seção de medição já dizia que veredito não é medido e que candidato fora do truth set não é erro. As duas juntas implicam a ausência de precision sem nunca nomeá-la, e "implica" não serve aqui: é a primeira pergunta que qualquer pessoa cética faz, e deixá-la sem resposta escrita transfere a resposta para uma thread de fórum, onde ela sai pior. Fica dito o que faltaria para medir — linhas, para existir veredito, e um gabarito para os candidatos fora do truth set — e fica dito que a afirmação disponível é a estreita: nenhum falso positivo confirmado contra os fixtures de integração, o que é deliberadamente menos do que "precision é alta". Apontado para a issue #36, que é onde isso vira número.
"After v0.1" com a v0.2.0 no ar lê como projeto parado, e o documento inteiro se chama "Roadmap de implementação — v0.1" enquanto as oito fases dele estão fechadas. Nos dois casos o texto está certo sobre o passado e mudo sobre o presente, que é a forma mais fácil de um repositório parecer abandonado para quem chega. O README passa a dizer qual é a release corrente e a listar o que vem como issue — #36 e #38 — em vez de prometer no próprio README. Promessa em roadmap não tem onde ser discutida; issue tem.
… inglês A seção de idioma afirmava que tudo na árvore é inglês exceto commits e `openspec/`. `docs/PGFATHOM.md` e `docs/ROADMAP.md` também são português, e são justamente os dois que o README chama de fonte da verdade — quem foi conferir encontrava a exceção não declarada, que é pior do que a exceção. Falta maior: o `docs/guide/` existe desde a change community-guide, é a camada de orientação em inglês sobre exatamente esse material, e o CONTRIBUTING não o mencionava em lugar nenhum. Um contribuidor de fora lia "o registro de design é em português" e não tinha como descobrir que havia um caminho. Agora tem, no topo e na própria seção de idioma.
"Homebrew works once the tap exists" era verdade quando foi escrito e virou o contrário: `lvcas-dotcom/homebrew-tap` existe, com `Casks/pgfathom.rb` gerado pelo goreleaser na 0.2.0. A frase condicional numa seção de instalação lê como "isto ainda não funciona", que é o pior lugar possível para uma ressalva vencida.
Vinte e cinco módulos e 11 MB está certo, e só no alvo do release: em `linux/amd64` são exatamente 25 e 11,1 MB. Construindo em Windows são 28, porque entram os módulos específicos da plataforma. O número está numa seção que convida o leitor a conferir — "vai abrir o go.mod primeiro" — então um leitor que confere e acha 28 encontra o projeto errado sobre si mesmo em vez de encontrar uma medição com alvo implícito.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes, and why
How it was verified
make fmt && make lint && make testmake test-integration(if it touches SQL, the catalog, or validation)Checks
openspec/, validating with--strict