Guia de contribuição
Como contribuir
- Se você for um colaborador externo, dê um fork no projeto
- Issues só poderão ser criadas com os templates especificados no repositório
- A criação de branches deve seguir a política de branches
- No desenvolvimento usar nossa política de commits
- Pull requests só serão aceitos se estiverem com o template especificado no repositório
- Antes de enviar qualquer contribuição, leia atentamente as diretrizes descritas neste documento e certifique-se de que sua alteração está alinhada com os objetivos do projeto
- Revise o código antes de abrir um Pull Request, garantindo que ele esteja funcionando corretamente e que não quebre funcionalidades existentes
- Inclua testes sempre que possível, principalmente ao adicionar novas funcionalidades
- Descreva claramente no Pull Request o que foi feito, o motivo e como testar
Políticas
Consulte nossas políticas para garantir que sua contribuição esteja em conformidade com as diretrizes do projeto, incluindo padrões de branches, commits, criação de issues e pull requests.
Dicas Finais
- Seja claro, objetivo e respeitoso com a comunidade e com os mantenedores do projeto.
- Sempre que possível, anexe evidências que ajudem na análise, como capturas de tela, trechos de código ou logs.
- Caso a issue seja resolvida e ainda esteja aberta, considere encerrá-la manualmente se aplicável.
- Lembre-se: abrir uma issue, um PR ou fazer um commit vai além de apontar ou resolver um problema — é uma forma de colaborar ativamente com a evolução do projeto.
Histórico de Versões
Versão | Data | Modificação | Autor(es) |
---|---|---|---|
1.0 | 15/05/2025 | Adiciona guia de contribuição | Jackes Fonseca |