58 lines
2.3 KiB
Markdown
58 lines
2.3 KiB
Markdown
# PR-014 [QUALITY]: Stabilize Workspace Formatting
|
|
|
|
## Briefing
|
|
|
|
O workspace ja tem uma trilha clara de qualidade com `fmt-check`, `clippy` e `test` no fluxo de CI. Hoje, porem, a barra minima de formatacao nao esta fechando: `cargo fmt -- --check` falha por divergencias de ordenacao de imports e estilo em arquivos ja versionados.
|
|
|
|
Esta PR trata esse problema como higiene de base. O objetivo nao e "embelezar codigo", e sim restaurar o contrato de estilo para que a arvore volte a ter um estado formatado, previsivel e mecanico.
|
|
|
|
## Problema
|
|
|
|
- `cargo fmt -- --check` falha no estado atual do workspace;
|
|
- ha arquivos versionados que divergem do estilo canonical do `rustfmt`;
|
|
- enquanto isso existir, o target `ci` deixa de ser confiavel como gate minimo de merge;
|
|
- a equipe perde sinal: falhas de estilo misturam ruido de higiene com problemas reais de implementacao.
|
|
|
|
## Alvo
|
|
|
|
- workspace Rust inteiro;
|
|
- arquivos tocados pelo `rustfmt` que hoje geram diff;
|
|
- fluxo `fmt-check` definido no `Makefile`.
|
|
|
|
## Escopo
|
|
|
|
- Rodar `cargo fmt` no workspace e revisar o diff gerado.
|
|
- Confirmar que as mudancas sao estritamente de formatacao, sem alteracao semantica.
|
|
- Restaurar `cargo fmt -- --check` para estado verde.
|
|
- Se necessario, ajustar qualquer arquivo novo ou recente que tenha escapado do padrao.
|
|
|
|
## Fora de Escopo
|
|
|
|
- Refatorar APIs.
|
|
- Renomear modulos.
|
|
- Resolver warnings de `clippy`.
|
|
- Alterar comportamento de testes ou runtime.
|
|
|
|
## Abordagem
|
|
|
|
1. Identificar exatamente quais arquivos fazem `fmt-check` falhar.
|
|
2. Aplicar `cargo fmt` no workspace.
|
|
3. Revisar diff para garantir ausencia de mudanca comportamental.
|
|
4. Revalidar com `cargo fmt -- --check`.
|
|
|
|
## Criterios de Aceite
|
|
|
|
- `cargo fmt -- --check` passa no workspace.
|
|
- O diff da PR e apenas de formatacao.
|
|
- Nenhuma logica, assinatura publica ou comportamento de teste muda por causa desta PR.
|
|
- O target `fmt-check` do `Makefile` volta a ser um gate confiavel.
|
|
|
|
## Tests
|
|
|
|
- Rodar `cargo fmt -- --check`.
|
|
- Rodar ao menos `cargo test --workspace --all-targets --all-features --no-fail-fast` se a PR tocar arquivos em crates com testes relevantes, apenas para confirmar ausencia de regressao acidental.
|
|
|
|
## Risco
|
|
|
|
Baixo. O risco principal e misturar formatacao com mudanca semantica no mesmo diff. A revisao deve ser severa: qualquer alteracao nao mecanica deve sair desta PR.
|