Regras e políticas de PR
Regras de PR
- Preferimos PRs menores.
- Se tiver acesso de escrita, experimente PRs empilhados com graphite — costuma ser concedido depois de bastante contribuição.
- Abra uma issue ou discussion se o PR trouxer mudanças arquiteturais.
Política de desenvolvimento
- Priorize design orientado a dados.
- Mantenha APIs simples e bem documentadas.
- Sempre cite a fonte se a implementação vier de outro projeto.
Desempenho
- Qualquer problema de desempenho é tratado como bug — runtime e tempo de compilação.
- Siga o livro de performance em Rust.
- Minimize o uso do crate
regex. Prefira iterators e métodos de string.
- Tempo de compilação deve ser o menor possível para não atrapalhar o fluxo nem ferramentas downstream.
- Reduza dependências de terceiros.
- Evite macros pesadas, genéricos excessivos ou truques que pioram compile time ou tamanho do binário.
- Nosso CI no GitHub Actions completa em ~3 minutos; regressões precisam ser corrigidas.
Política de manutenção
- Acompanhe cobertura de código e código morto. Alvo: ~99% de cobertura.
- Trabalhe ativamente para reduzir o tempo de CI e acelerar merges. Hoje o CI no GitHub Actions leva cerca de 3 minutos.
- Documentação em primeiro lugar — ela é a fonte da verdade. Mantenha atualizada e compartilhe links em vez de repetir as mesmas respostas. Veja a abordagem handbook-first do GitLab.
- Ordem consistente de imports: do “mais distante” ao “mais próximo”.
std- Crates externos
- Crates Oxc
- Crate local (
crate) supermod
Conventional Commits
Seguimos Conventional Commits:
O commit traz estes elementos estruturais para comunicar intenção:
fix: corrige um bug.feat: introduz uma funcionalidade nova.- BREAKING CHANGE: acrescentar
!após tipo/escopo indica mudança breaking na API, ex.:feat(parser)!: new feature. - os escopos são nomes de crates.
- os tipos são
feat:,fix:,chore:,ci:,docs:,style:,refactor:,perf:etest:.
Política de ação
Trecho dos valores da Astral:
Tendemos à ação, mesmo diante da incerteza. Preferimos fazer com pragmatismo a prolongar debates; preferimos pedir perdão a pedir permissão. Valorizamos decisividade — sobretudo quando a decisão não é óbvia e sobretudo quando pode ser revertida.
Tendência à ação não é imprudência. É inclinar-se a decisões responsáveis e a executá-las com urgência, mesmo com ambiguidade remanescente ou incógnitas conscientes.