Para contribuir com nosso projeto, antes você precisa realizar o Fork do nosso repositório, e após isso você precisa seguir os seguintes tópicos deste guia :
É de extrema importância que antes de fazer qualquer alteração em nosso projeto, que seja lido o nosso Código de conduta, para que esteja claro as regras e boas condutas que esperamos para que exista uma contribuição saudável e respeitosa.
Um ótimo começo para que se inicie a sua contribuição, é a abertura de uma Issue.
Uma Issue pode ser utilizada de várias formas, desde relatar um Bug até sugerir uma evolução ou funcionalidade ao projeto.
As Issues devem possuir título, descrição, no mínimo um assinante responsável e labels.
Para que a Issue esteja correta, ela precisa seguir os modelos de Issues Templates que se encontram em nosso repositório : Issue Template
Os commits devem ser feitos usando o parâmetro -s para indicar sua assinatura no commit.
git commit -s
A issue vinculada a este commit (caso exista), deve ser citada no commit, para isso, basta adicionar #<numero_da_issue>.
#5 Fazendo guia de contribuição
** **Por padrão, o caracter # define uma linha de comentário no arquivo da mensagem do commit. Para resolver este problema, use o commando:**
git config --local core.commentChar '!'
Igualmente, para commits em dupla deve ser usado o comando -s , e deve ser adicionado a assinatura da sua dupla.
git commit -s
Comentário do commit:
#5 Fazendo guia de contribuição
Signed-off-by: eliseukadesh67 <[email protected]>
Para que ambos envolvidos no commit sejam incluídos como contribuintes no gráfico de commits do GitHub, basta incluir a instrução Co-authored-by: na mensagem:
#5 Fazendo guia de contribuição
Signed-off-by: foo <[email protected]>
Signed-off-by: bar <[email protected]>
Co-authored-by: foo <[email protected]>
Co-authored-by: bar <[email protected]>
Para commits que incluem uma pequena mudança emergencial em uma issue que já teve sua resolução encerrada, deve-se iniciar a mensagem do commit com HOTFIX #<numero_da_issue> <mensagem>
Exemplo de comentário do commit:
HOTFIX #5 Atualizando guia de contribuição do projeto
O Pull Request é uma forma mais técnica de propor uma mudança estrutural no código do projeto.
Primeiramente para que o Pull Request esteja correto, ele precisa seguir o Pull Request Template que está presente em nosso repositório.
Para a revisão e análise do Pull Request, o Code review deve ser feito por um ou mais membros da equipe que não participaram das modificações.
Qualquer pessoa que esteja disposta a ajudar pode contribuir com nosso projeto, tanto sugerindo evoluções e funcionalidades, quanto reportando Bugs.
Todos que tenham algo a contribuir com nosso projeto são mais que bem vindos, e serão recebidos com gratidão e respeito.
😊