Ir para o conteúdo

Guia de contribuição

1. Introdução

Como contribuir para o projeto Alectrion ?

Siga as diretrizes abaixo.

2. Diretrizes para contribuir

2.1 Código de Conduta

Siga o seguinte código de conduta [3] para contribuir em qualquer repositório desse projeto.

2.2 Politica de branches

Repositórios de desenvolvimento

Nos repositórios do código do projeto temos uma branch principal, a develop.

A branch develop é a branch mais estável do projeto, que estará em produção. Essa branch é protegida de commits e para o desenvolvimento de novas funcionalidades, deve receber Pull Requests (PRs).

Novas branches

As branches para o desenvolvimento de novas features devem ser criadas a partir da branch develop e devem seguir o padrão x-nome-da-issue, onde x é o número da issue que será resolvida na branch, acompanhado pelo nome da issue.

Os Pull Requests das novas branches devem ser feitos para a branch develop.

Em casos de correções rápidas de bugs, a branch deve seguir o padrão FIX-x-problema-a-ser-resolvido, onde x é o número da issue, caso tenha.

Repositório de documentação

No repositório de documentação na develop está o código da página de documentação do github pages. A branch develop está protegida e só deve aceitar modificações por Pull Requests..

As novas branches, assim como nos repositórios de desenvolvimento devem seguir a estrutura x-nome-da-issue.

2.3 Politica de Issues

A criação de novas issues deverá seguir um dos padrões estabelecidos abaixo:

  • Bug report: para relatar problemas, erros, defeitos ou falhas;

  • História de usuário: quando for descrever funcionalidades a nível de história de usuário;

  • Geral: utilizado para criar ou relatar tarefas ou outras atividades gerais.

2.4 Política de Commit

Os commits deverão seguir o padrão de mensagens especificado pelo Conventional Commits [2]. As seguintes regras também se aplicam:

  • A descrição de um commit deve ser escrita em Português;

  • Um commit deve referenciar a issue trabalhada;

  • Um commit deve representar uma unidade de trabalho. Por exemplo: não adicionar arquivos relacionados a issues diferentes no mesmo commit;

Exemplo: Issue 1: Realizar autenticação do usuário (serviço)

git commit -m "#1 feat: adicionado serviço de autenticação"

2.5 Pareamento

Para tarefas realizadas em pares, os commits precisam seguir o seguinte padrão:

Descrição do commit

Signed-off-by: Nome do responsável <nome@gmail.com>
Co-authored-by: Nome de quem auxiliou <auxiliador@gmail.com>

Obs.: o email PRECISA ser o mesmo que está vinculado à conta do Github.

  • 'Signed-off-by: ' deve ser preenchido pelo responsável pelo código;

  • 'Co-authored-by:' deve ser preenchido por quem prestou auxílio durante a tarefa.

3. Referências

[1] EQUIPE ALECTRION 2022-1. Como contribuir. Disponível em: https://fga-eps-mds.github.io/2022-1-Alectrion-DOC/documentation/Documentos/guia-contribuicao.html

[2] CONVENTIONAL COMMITS. Conventional Commits. Disponível em: https://www.conventionalcommits.org/en/v1.0.0/

[3] CONTRIBUTOR COVENANT. CONTRIBUTOR COVENANT CODE OF CONDUCT. Disponível em: https://www.contributor-covenant.org/version/2/1/code_of_conduct/

[4] EQUIPE ALECTRION 2022-2. Como contribuir. Disponível em: https://fga-eps-mds.github.io/2022-2-Alectrion-DOC/#/./Documentos/guia-contribuicao

4. Histórico de versão

Data Descrição Autor(es)
23/04/2023 Criação do Guia de Contribuição João Pedro
24/04/2023 Revisão do Guia de Contribuição Lucas Lima