Mudança pequena e revisável

A documentação recomenda organizar trabalho em branches e entregar por pull request.

  1. 1
    Delimitar

    Definir problema, critérios de aceite e componentes afetados.

  2. 2
    Criar branch

    Isolar a mudança segundo a convenção do repositório.

  3. 3
    Implementar

    Fazer commits coesos e sem credenciais ou dados reais.

  4. 4
    Verificar

    Executar testes, análise estática e revisão local.

  5. 5
    Abrir pull request

    Explicar motivação, impacto, evidências e reversão.

  6. 6
    Revisar e integrar

    Resolver comentários e só então mesclar pelo fluxo aprovado.

Checklist de pull request
[ ] Escopo e risco descritos
[ ] Testes relevantes executados
[ ] Sem segredo ou dado pessoal
[ ] Compatibilidade avaliada
[ ] Logs não expõem conteúdo clínico
[ ] Migração e reversão documentadas

Testes e análise estática

Os guias dedicam páginas a testes unitários e ao uso do SonarLint.

PráticaDetecta melhorNão substitui
Teste unitárioRegra e comportamento isoladoIntegração real
Teste de integraçãoContrato, banco e serviçosCarga e resiliência
Análise estáticaProblemas de código e manutençãoRevisão de arquitetura
Revisão humanaContexto, clareza, risco e segurançaExecução automatizada
Teste de desempenhoLatência, throughput e saturaçãoCorreção funcional completa

Cuidados em integrações clínicas

Mudanças de conector e API afetam semântica, identidade e disponibilidade.

  • Versionar consultas, modelos simplificados e transformações em conjunto.
  • Cobrir cardinalidade, identificadores e códigos clínicos nos testes.
  • Usar dados sintéticos ou devidamente protegidos.
  • Testar idempotência, timeout, retry e falha parcial.
  • Instrumentar métricas antes de publicar a mudança.
  • Preparar reversão sem apagar evidências.

Frontend e acessibilidade

A documentação de aplicações registra práticas de desenvolvimento frontend, embora contenha ruído editorial.

  • Separar apresentação de autenticação e regra de autorização.
  • Tratar sessão, carregamento, vazio e erro de forma explícita.
  • Não renderizar HTML recebido de fontes não confiáveis sem sanitização.
  • Manter navegação por teclado, rótulos e contraste.
  • Testar layouts responsivos e textos ampliados.