Workflow de Contribuições

Estrutura

Utilizaremos o Git Flow para estruturar o desenvolvimento.

• O código da branch master será o código utilizado no deploy do Bot e segue o procedimento de deploy para subir a aplicação.

• O código na branch develop será sempre o código base a ser utilizado para implementação de novas features.

• Para cada nova feature deve ser criada uma nova branch a partir da develop para servir o novo código até o fim da implementação.

• Assim que devidamente implementada e testada a nova funcionalidade, levaremos o código novo para a branch develop.

O procedimento de novos releases deve seguir uma lógica parecida: para cada novo release, criar uma release branch a fim de fazer ajustes finos necessários ao novo deploy e ao fim dos ajustes, enviar o novo código para a master e para a develop.

Todo PR será revisado por um contribuidor antes de ter o merge aprovado.

Procedimento para contribuição em issues:

1. Criar uma nova branch para a issue, a partir da develop com a nomenclatura:

Tipo de Issue	Regra do nome da Branch	Exemplo
Feature	feature/<msg>	feature/simplificar-audio
Documentação	doc/<msg>	doc/tutorial-deploy
Bug	bug/<msg>	bug/mem-leak-thread-song
Hotfix	hotfix/<msg>	hotfix/msg-boas-vindas

2. Fazer as alterações no código necessárias na nova branch.
3. Abrir um pull request enviando o código para a develop

Caso seja uma contribuição externa, este procedimento deve ser realizado em um fork do projeto