Este arquivo é destinado para aqueles que desejam contribuir com o ChuviscoBot. Este é um projeto aberto e livre, e todos os interessados podem fazer contribuições por meio de Pull Requests.
Se encontrar algum erro ao utilizar o bot, ou então caso queira sugerir o desenvolvimento de uma nova feature, por favor cadastre uma issue. Os mantenedores do projeto deverão ler suas contribuições.
Se estiver certo sobre uma correção feita ou com outro tipo de desenvolvimento concluído, um Pull Request pode ser submetido diretamente. O sistema de issues, porém, enriquece o projeto com discussões do que é possível ou não implementar neste sistema e seu uso é altamente encorajado.
Conforme mencionado anteriormente, o projeto é aberto e aceita contribuições por meio de pull requests. Para que possa ser aceito, o código deve, porém, passar pelos testes de possibilidade de integração. Um pull request pode ser rejeitado caso haja objeções a ele, mesmo que passe em todos os testes.
Além dos testes implementados para aceitar os pull requests, o contribuidor pode utilizar testes locais em sua máquina como uma ferramenta adicional para união de seu código com o do que já está no projeto.
O padrão de contribuições com projetos open source pelo github é seguir os passos:
- Fazer um fork do projeto com o qual deseja contribuir;
- Clonar o projeto em seu usuário em sua máquina local;
- Para que o seu projeto fruto do fork esteja alinhado com os trabalhos feitos no repositório original, é necessário nomear o repositório original como upstream do seu repositório local (mais informações: )
- Recomenda-se que cada funcionalidade nova em ou issue sendo resolvida tenha seu desenvolvimento em uma branch separada.
- Além da subdivisão em branchs, recomenda-se também que seus commits mencionem a issue sendo tratada.
Também é recomendado que o repositório original seja configurado como upstrea e que o repositório local esteja sempre devidamente sincronizado.
O projeto está em desenvolvimento contínuo, e por isso é fundamental que tenha sua documentação atualizada com frequência.
Contribuições de documentação são igualmente valorizadas e encorajadas como contribuições de código.