Skip to content

Latest commit

 

History

History
134 lines (84 loc) · 2.87 KB

File metadata and controls

134 lines (84 loc) · 2.87 KB

Contribuindo

Obrigado pelo interesse em contribuir com este repositório.

Este projeto faz parte do meu portfólio profissional.

Contribuições são bem-vindas, desde que sigam os critérios técnicos e comportamentais descritos abaixo.


1. Princípios

Este repositório segue princípios de engenharia orientados a:

  • Clareza e legibilidade
  • Simplicidade arquitetural
  • Baixo acoplamento
  • Alta coesão
  • Testabilidade
  • Manutenibilidade
  • Segurança
  • Performance consciente

Toda contribuição deve respeitar esses princípios.


2. Antes de Contribuir

Antes de abrir uma issue ou pull request:

  1. Verifique se já existe discussão semelhante.
  2. Seja claro sobre o problema ou melhoria proposta.
  3. Justifique tecnicamente sua sugestão.
  4. Mantenha a comunicação objetiva e profissional.

Discussões devem ser orientadas a solução, não a opinião.


3. Padrões de Código

As contribuições devem:

  • Seguir o padrão de organização já adotado
  • Manter consistência de estilo
  • Evitar complexidade desnecessária
  • Não introduzir dependências sem justificativa clara
  • Incluir testes quando aplicável
  • Não quebrar funcionalidades existentes

Código deve ser escrito como se fosse mantido por você no longo prazo.


4. Commits

Recomenda-se:

  • Commits pequenos e focados
  • Mensagens claras e descritivas
  • Uso de padrão semântico quando aplicável

Exemplo: feat: adiciona validação de entrada no serviço de autenticação fix: corrige condição de corrida no processamento assíncrono refactor: simplifica lógica de agregação de dados

Evite commits genéricos como: update fix bug ajustes


5. Pull Requests

Um Pull Request deve:

  • Ter objetivo claro
  • Descrever o problema resolvido
  • Explicar decisões técnicas relevantes
  • Ser coeso e bem delimitado
  • Não misturar múltiplas mudanças não relacionadas

Pull Requests poderão receber:

  • Solicitação de ajustes
  • Questionamentos técnicos
  • Rejeição justificada

A decisão final é do mantenedor.


6. Issues

Ao abrir uma issue:

  • Descreva o contexto
  • Informe comportamento esperado
  • Informe comportamento atual
  • Inclua logs ou evidências quando possível

Issues vagas ou sem contexto suficiente podem ser encerradas.


7. Processo de Revisão

Como único mantenedor:

  • Todas as contribuições passam por revisão técnica
  • Critérios de aceitação incluem qualidade, alinhamento arquitetural e impacto
  • Nem toda sugestão será incorporada

Este repositório não tem obrigação de roadmap público.


8. Código de Conduta

Ao contribuir, você concorda em seguir o Código de Conduta deste repositório.

Comportamento profissional é requisito básico para colaboração.


9. Observação Final

Este projeto representa minha visão e liderança técnica.

Contribuições que elevem qualidade, clareza e robustez são sempre bem-vindas.