Guia de Contribuição
1. Histórico de versão
| Versão | Data | Descrição | Autor |
|---|---|---|---|
| 0.1 | 04/02/2022 | Criação da documentação sobre Guia de Contribuição | Paulo Victor |
| 0.2 | 27/02/2022 | Adição do Garimmit e refatoração de branches | Vinicius Saturnino e Mateus Gomes |
| 0.3 | 02/03/2022 | Revisão de ortografia e adição de links para o script Garimmit | Vinicius Saturnino e Mateus Gomes |
| 0.4 | 03/03/2022 | Revisão do documento | Victor Gonçalves |
| 0.5 | 03/03/2022 | Revisão das informações de branch | Vinicius Saturnino e Mateus Gomes |
2. Política de Issues
Crie uma nova issue seguindo as instruções presentes dentro do template de criação de features presente no repositório. São elas:
- Descrição do problema, caso a issue esteja relacionada a um.
- Descrição do tipo de solução que é esperada ou do que se espera com a nova feature.
- Definição dos critérios de aceitação.
3. Política de Branches e Commits
Através da imagem abaixo iremos implementar o git flow do projeto, de maneira que para uma mudança impactar a branch master (branch principal) os seguintes passos deverão ser seguidos:
- Deve-se criar uma branch nova a partir da master;
- Ao acabar a implementação na branch nova, deve ser criado um PR para ser avaliado, preenchendo os campos necessários do modelo pré-determinado;
- Caso o PR seja aprovado, a branch nova será apagada e o seu conteúdo estará na master.
Toda nova branch deverá seguir um padrão de nomenclatura, sendo o número da issue seguido por _ e um nome significativo para aquela branch.
Exemplo:
git checkout -b 153_tela_login
O padrão de commits será o seguinte:
Exemplo:
feat: create a new feature --commit
4. Garimmit
Como forma de ajudar o grupo, facilitar e garantir os padrões de commits e branches, foi criado um script para auxiliar os membros na hora de subir alguma alteração para o repositório. O garimmit está disponível na raíz do repositório na Wiki.
Instalação do Garimmit
Para utilizar o garimmit como um comando nativo, foram disponibilizados os seguintes passos:
cd ~
mkdir bin
Para prosseguir, o script garimmit deve estar dentro do diretório bin criado.
cd bin
chmod u+x garimmit
Abrir o bashrc ou zshrc
nano ~/bashrc
ou
nano ~/zshrc
e adicione a seguinte linha no arquivo
export PATH=$PATH:~/bin
Agora basta instalar o arquivo bashrc ou zshrc com as mudanças
source ~/bashrc
ou
source ~/zshrc
Pronto, o garimmit foi instalado localmente. Basta reiniciar o terminal e ele estará disponível para uso.
Uso do Garimmit
O garimmit possui uma comunicação bem simples e direta. Basta inserir a mensagem do commit, dizer se o commit é em pareamento ou não (ele já possui a linha de co-authored para todos os membros da organização com seus devidos apelidos minúsculos) e ele vai te mostrar a mensagem formatada, caso esteja correta, basta confirmar que ele faz o commit. Segue um exemplo abaixo:
