Guia de Contribuição

O Guia de Contribuição é um documento que visa ensinar como participar deste projeto Open Source.

Começando

• Fork o projeto no GitHub. Tutorial para realizar o Fork.

  

• Clone do projeto. Tutorial de como clonar um repositório

  

• Criar uma issue no repositório original, seguindo o template estabelecido com descrição, critérios de aceitação, tag e os responsáveis.

• Criar uma branch com o numero_issue-nome_issue

  git checkout -b 12-bug_fixed

• Utilize um editor de texto/IDE de sua preferência para realizar a sua contribuição.

• Adicionando suas modificações no Git, Como commitar e fazer um push.

  Adicionando uma única modificação ao commit:

  git add caminho/arquivo.txt

  Você pode adicionar todos os arquivos usando:

  git add .

  Note: usando o git add . irá automaticamente adicionar todos os arquivos. Vocẽ pode fazer um git status para ver quais arquivos foram modificados.

• O Commit deve ser (#numero_issue): descrição.

  git commit -m "(#12): Correção de um bug"

• Realize o push para a branch em que está sendo desenvolvida essa issue:

  git push origin branch-nome

• Submeta um novo pull request:

• Primeiro certifique-se que a branch "dev" esteja selecionada para o pull request, todo pull request deve ir para a branch dev. Depois disso clique em "Criar pull request".

• Certifique-se de preencher o template do pull request com o título, descrição, mudanças, screenshots e issue. Por fim, crie o pull request.

Versionamento

Data	Versão	Descrição	Autor(es)
23/11/2022	1.0	Elaboração do Guia de Contribuição	Thiago Luiz, Caio Sulz
06/12/2022	1.1	Complemento do tutorial de Pull Request	Caio Sulz