Contribuições
O segredo do sucesso para qualquer software de código aberto é uma comunidade forte, atuante e ativa. As contribuições são valiosas amostras do que a comunidade é capaz de fazer. No entanto, para que o processo de incorporação seja harmonioso devemos nos atentar ao fato de que um código aberto presume que muitas mãos atuam simultaneamente no processo de desenvolvimento, o que pode virar uma bagunça não acha?
O ponto aqui é que ao participar da comunidade, o contribuidor concorda em seguir os Padrões e Normas estabelecidos no contexto da comunidade, o que evita esta "bagunça" relatada no parágrafo anterior. No decorrer deste documento, definimos padrões, boas práticas e documentação e fluxos de trabalho e esperamos que cada um de nossos estimados contribuidores sigam a cartilha a risca.
Para facilitar a adesão dos membros, deixamos aqui um pequeno checklist do que você precisa observar antes de submeter uma contribuição aos códigos da comunidade.
Checklist
- Documentação (Consulte o tópico Documentação)
- Testes Automatizados (Consulte o tópico Estratégia de Revisão de Código)
- Linting do código (Atente-se ao alerta descrito ao fim do tópico Editor de texto ou IDE)
- Use os padrões de repositórios propostos. (Verifique o repositório de interesse e use os padrões presentes no reposítório como descrito no tópico Padrões)
- Qualquer migração de banco de dados será avaliada conforme padrões descritos no tópico Banco de Dados seguindo o MAD proposto pela SEIDIGI/DATASUS/MS.
Além disso, ao utilizar o nosso repositório, lembre-se de seguir as definições descritas no tópico Desenvolvimento Colaborativo, conforme segue:
- Método de ramificação empregado
- Padrões para nomenclatura de branches
- Padrões para nomenclatura de Merge Requests/Pull Requests