Como contribuir
Versionamento
| Versão | Data | Modificação | Autor |
|---|---|---|---|
| 1.0 | 25/04/2023 | Criação do documento | Carlos Eduardo de S. Fiuza |
| 1.1 | 25/04/2023 | Adição dos tópicos | Carlos Eduardo de S. Fiuza e Jonathan Oliveira |
| 1.2 | 30/04/2023 | Adição de hyperlinks | Carlos Eduardo de S. Fiuza e Jonathan Oliveira |
| 1.2 | 05/05/2023 | Revisão do documento | Paulo Batista, Davi Matheus e Luis Marques |
Para contribuir
É necessário estar atento e seguir as políticas do projeto, sendo elas:
- Política de branches;
- Política de commits;
- Código de conduta;
- Critérios de aceitação da issue associada;
- Implementação de testes sobre o código adicionado (quando aplicável).
No que contribuir
Navegue pelas issues abertas para encontrar algo no que trabalhar, mas caso possua alguma ideia de funcionalidade ou queira reportar algum bug/incidente, crie uma issue usando os templates disponíveis, sendo classificado como funcionalidade ou bugfix.
Trabalhei numa issue, e agora?
Após trabalhar numa issue e completar os critérios de aceitação da mesma, crie um pull request seguindo o template disponível. O(s) mantenedore(s) irão analisar o trabalho realizado e se necessário:
- criar tópicos de perguntas e dúvidas;
- indicar melhorias;
- pedir novos testes que atendam casos de uso.
Caso seja aprovado o pull request e as verificações de testes estejam ok, seu trabalho será mesclado a ramificação de destino e sua contribuição estará finalmente realizada ao projeto! Parabéns :)