Skip to main content

Adequação do repositório

Este monorepo é maior que o gb-travio-webhooks, mas deve manter a mesma postura operacional.

Regras de continuidade

  • escrever READMEs diretos
  • manter o status de runtime e as superfícies de replay explícitos
  • preferir configuração tipada em vez de comportamento implícito de ambiente
  • tratar auditabilidade e entregas rejeitadas como requisitos de produto
  • manter a CI legível o suficiente para ser auditada rapidamente
  • lançar através do GitHub, não a partir de um laptop

Padrão de PR

Todo PR de funcionalidade deve incluir:
  • código tipado
  • testes para o caminho principal e ao menos um caminho de falha
  • documentação para superfícies de runtime novas ou alteradas
  • notas explícitas onde o comportamento mockado ainda substitui a persistência durável

Padrão de runtime

Toda superfície operacional deve documentar:
  • caminho do endpoint
  • modelo de autenticação
  • formato de requisição e resposta
  • modos de falha
  • postura de retry ou replay

Leia a seguir