Gitea

O Gitea é o serviço utilizado para controle do código dos projetos, similar ao GitHub.

Esta página tem como objetivo mostrar funcionalidades básicas do serviço.

Pull request

Todas as vezes que uma funcionalidade ou correção for mesclada com a branch principal, deve-se abrir um Pull Request para que haja revisão do código (ou Code Review).

As regras de revisão podem variar de acordo com o projeto, mas, de forma geral, atente-se a:

  • O novo código segue a padronização do projeto?

  • Se é uma correção, os testes unitários que deveriam ter encontrado o erro foram consertados ou melhorados para que o erro não se repita?

  • Se é uma melhoria, novos testes foram adicionados para garantir a consistência da nova funcionalidade?

  • Os mecanismos de documentação automática (Swagger, por exemplo) foram adaptados para refletirem as novas mudanças?

Abertura de PR

Na página do projeto que você está atuando, entre na seção de Pull Requests e clique em New Pull Request. Menu de PR

Na próxima tela, selecione qual a branch de destino e qual a branch de origem. Supondo que a branch de destino seja dev e a branch de origem (a branch onde você está trabalhando) é feature/1234-novo-usuario, a interface ficará da seguinte forma: Seleção de branches do PR

Clique em New Pull Request e edite o título e descrição, se necessário. Aproveite o momento para revisar o código e garantir que não tenha subido algo que não deveria (TODO, comentários desnecessários, print e console.log). Estando tudo certo, clique em Create Pull Request.

Se o projeto estiver configurado para rodar um mecanismo de CI, verifique se não houve nenhum erro.

Durante a revisão

Caso você esteja abrindo o PR, é possível selecionar revisores específicos. Para isso, localize a seção Reviewers dentro do PR (lado direito), clique na engrenagem e adicione as pessoas que você gostaria que revisassem seu código. Seleção de revisores do PR

Se você estiver revisando

Neste caso, clique na aba Files changed e visualize todas as alterações. No lado esquerdo desta tela, existe a estrutura de arquivos modificada e pode ser útil para ter uma visão geral das alterações.

Caso o arquivo revisado esteja adequado, clique no checkbox Viewed. Desta forma, o arquivo ficará colapsado durante a revisão e, caso haja alguma alteração futura neste PR, aparecerá um aviso indicando que houve mudança neste arquivo desde a última revisão. Arquivo visualizado

Caso haja algum problema, adicione um comentário na linha onde o erro existe, bastando clicar no + e preencher, de forma objetiva, o que deve ser corrigido. Adicionando comentário no arquivo do PR

Após revisar, você decide se o PR deve ser aprovado ou não. Para isso, basta clicar em Review no topo direito da tela e selecionar Accept ou Request changes. Importante: enquanto a última etapa não ocorrer, o dono do PR não conseguirá visualizar os comentários.

Após a revisão

Caso esteja aprovado e você tenha as permissões adequadas, você poderá mesclar as branches e excluir a branch de origem.

CI/CD

Caso o projeto tenha um mecanismo de CI/CD configurado, é possível visualizar o andamento através da aba Actions. O que ocorre em cada action e as consequências disso dependem da configuração do projeto. De forma geral, uma action é um container Docker configurado na pasta .gitea através de um arquivo YAML.