Skip to main content

Padrões do repositório

  • manter o código totalmente tipado
  • adicionar stories do Storybook para qualquer superfície de UI personalizada
  • documentar mudanças de runtime na documentação
  • manter feature flags aditivas
  • preferir comportamento operacional direto em vez de teatro de abstração

Padrão de pull request

Toda fatia de funcionalidade (feature slice) deve incluir:
  • mudanças tipadas em aplicações e packages
  • testes para o comportamento alterado
  • documentação atualizada em apps/docs e docs/*.md quando relevante
  • notas explícitas de rollout, replay ou rollback para mudanças operacionais
  • notas de review adversarial quando a funcionalidade toca correção ou limites de segurança

Adequação ao repositório

Espera-se que o repositório siga o estilo operacional do gb-travio-webhooks:
  • propósito do repositório direto e explícito
  • CI e processo de release legíveis
  • comportamento de runtime com pouca “mágica”
  • contratos internos documentados
  • runbooks e notas de review armazenados no próprio repositório
Veja Adequação do repositório para as convenções de nível de repositório herdadas do gb-travio-webhooks.

Observação sobre a implementação atual

O repositório já possui tanto uma camada de repositório com mock tipado quanto o contrato de schema/env do Supabase. Para contribuidores, a suposição segura hoje é:
  • a maior parte da iteração de UI e API ainda acontece contra o caminho com mock
  • o comportamento suportado pelo Supabase deve ser documentado explicitamente quando uma superfície estiver de fato conectada
  • os contratos de app e API devem permanecer estáveis conforme a implementação de armazenamento muda por trás deles

Comandos de alto valor

Use execuções direcionadas por package para restringir falhas rapidamente:

Leia a seguir