Skip to main content

Fluxo de contribuição

Este repositório favorece pull requests estreitos e revisáveis em vez de grandes reescritas de plataforma.

Fluxo padrão

  1. Abra ou confirme uma issue primeiro se a mudança afetar comportamento, arquitetura ou política de contribuidores.
  2. Crie uma branch ou worktree focada.
  3. Implemente a menor fatia completa que possa ser revisada isoladamente.
  4. Atualize a documentação em apps/docs para mudanças de comportamento visíveis ao usuário ou ao contribuidor.
  5. Atualize as notas de nível de repositório em docs/*.md quando a mudança afetar arquitetura, CI/CD, migration ou postura operacional.
  6. Execute o conjunto de verificação local antes de pedir review.

Verificações locais mínimas

Use execuções direcionadas ao restringir falhas:

O que um bom PR inclui

  • um conjunto de mudanças coerente
  • código tipado
  • testes para o comportamento alterado
  • atualizações de documentação
  • uma nota breve sobre rollout, replay ou impacto operacional, se relevante
Quando uma branch vai durar mais do que uma correção rápida, prefira um worktree separado. Veja Worktrees.

O que evitar

  • misturar refatorações não relacionadas em um PR de funcionalidade
  • mudar contratos de rota sem atualizar a documentação
  • publicar na documentação afirmações de arquitetura que o código ainda não cumpre
  • combinar mudanças amplas de dependências com mudanças de comportamento de produto

Leia a seguir