Ir para o conteúdo

Guia de Contribuição

Como contribuir?

Contribuições ao projeto são muito bem-vindas. Para manter um projeto bem organizado, ao contribuir observe as políticas abaixo:

Política de Issues

Para criação de issue, um template de issue deve ser seguido.

Caso encontre um bug ou tenha alguma sugestão de melhoria ao projeto, siga os passos abaixo:

  1. Verifique se já existe a issue no repositório;
  2. Caso não exista nenhuma issue relacionada, crie uma issue;
  3. Escolha o template de issue;
  4. Preencha a issue de acordo com a orientação do template;
  5. Defina as labels que são pertinentes ao problema ou sugestão;
  6. Se aplicável, defina os responsáveis pela issue, o milestone e o projeto.
  7. Retire dúvidas através da issue.

Gitflow

Para contribuir com o projeto, observe as políticas adotadas em relação a padronização e organização de código e documentação.

Documentação

Regras:

  1. Novas branchs devem ser criadas a partir da dev;
  2. Após a criação de todos os arquivos, executar o comando mkdocs gh-deploy para realizar o deploy da documentação no GitHub.
  3. Depois de fazer modificações na branch, submete-a por pull request para integrar a branch principal (dev);
  4. Após aprovado ou recusado o pull request, apague a branch.

Código

  1. Novas branchs devem ser criadas a partir da dev;
  2. Depois de fazer modificações na branch, submete-a por pull request para integrar a branch principal (dev);
  3. Depois de fazer modificações na branch, submete-a por pull request para integrar a branch secundária (dev);
  4. Após aprovado ou recusado o pull request, apague a branch.

Política de Branches

main

main é a branch de produção, onde se encontra a versão que estará disponível para as apresentações de ponto de controle.

dev

dev é a branch de homologação, onde se encontra a versão mais atualizada do projeto.

Nome das Branches

Crie a branch com a seguinte estrutura:

[número-da-issue]-<nome-significativo-da-branch-separada-por-hífens-com-letras-minusculas-sem-acento>

Política de Commits

Os commits deverão ser feitos em inglês iniciando com um verbo no presente simples, como, por exemplo: "Create a new API entrypoint".

Para commits individuais, use: git commit -m "Mensagem". Para commits em pares, digite git commit e atribua os co-authoreds na mensagem:

Mensagem do commit


Co-authored-by: Nome e sobrenome do parceiro(a) <email@email.com>
  • Observação: quebrar duas linhas após a mensagem do commit.

Título dos Commits

Commits devem seguir os seguitnes modelos:

  • Commit de correção de bugs ou falhas na main: [HOTFIX] Mensagem;
  • Commits de correção de bugs ou falhas gerais: [FIX] Mensagem;
  • Os demais commits devem seguir o modelo: Mensagem.

Política de Merges e Pull Requests

Pull Requests

Pull requests serão realizados para controle de estabilidade das branches:

  • main;
  • dev.

Quando disponível uma nova release ou funcionalidade, esta será integrada através de pull request na branch main.

Caso um pull request já estava aberto e atualmente está em progresso, o título deve seguir o padrão [WIP] Título.

Durante a criação de um pull request, deve-se observar o template definido no repositório.

Code Review

Na revisão de código de pull request, observe os pontos abaixo:

  • O pull request deve ser aceito por pelo menos um membro da equipe;
  • O revisor deve clonar a branch do pull request e verificar se as modificações de código ou documentação são coerente;
  • Em caso de aceitação do pull request, deve-se fazer a aprovação e realizar o merge;
  • Caso o pull request esteja faltando algum requisito, deve-se informar ao contribuidor as mudanças necessárias;
  • Caso o pull request não faça sentido, já tenha sido resolvido ou seja duplicado, deve ser fechado e feito um comentário a respeito.