Home

Manual de contribuição para o projeto no repositório do GitHub

Inicialmente é preciso configurar a máquina de desenvolvimento, essa deve conter a instalação das tecnologias listadas abaixo:

• Git
• Node 17.9.0
• Python3
• Yarn 1.22.15

Para contribuir com o projeto é necessário fazer um fork.

Com isso, uma cópia do projeto é criada na conta utilizada no github. Na cópia, deve-se clicar no botão Code, assim poderá abrir os endereços ( HTTPS, SSH, Github CLI ). Com o endereço copiado é só clonar o repositório na máquina local.

Para vincular o projeto local com os 2 repositórios remotos, o origin (cópia) e o upstream (projeto original), é necessário rodar o seguinte comando utilizando o link do repositório original:

git remote add upstream https://github.com/DCOMP-UFS/SergipeAberto.git

Alguns comandos importantes para visualização e organização:

• Para visualizar os dois repositórios

git remote -v

• Trazer as branches da upstream

git fetch upstream

• Vincular o main local com a main upstream

git branch -u upstream/main main

• Atualizar a main local com o código da main upstream

git pull

Para realizar alterações/adições no projeto é recomendado seguir o fluxo do gitFlow, em que o código só será integrado na main ao ser finalizado e revisado. Assim é preciso criar uma branch local com o comando abaixo.

git checkout -b feat/descricao

Ao finalizar as alterações, executar o(s) commit(s) e push, disponibilizando o código no github, você poderá criar uma Pull request(PR).

Ao clicar no botão é possível escolher a branch que você pretende incluir as alterações, branch de destino. Além disso, é recomendado que escreva uma mensagem indicando as alterações/adições realizadas para que os outras pessoas voluntários entendam e possam avaliar. Com a PR postada é importante acompanha-la, também é recomendado avaliar outras PR, assim estará contribuindo para criar um círculo de evolução do projeto.