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 para contribuir em qualquer repositório deste projeto.

2.2 Política de Branches

Repositórios de Desenvolvimento

Nos repositórios do código do projeto, temos a branch principal, a develop. Esta branch é a mais estável e está em produção. Para o desenvolvimento de novas funcionalidades, deve-se criar branches a partir da develop, seguindo o padrão x-nome-da-issue. Os Pull Requests das novas branches devem ser feitos para a develop.

Repositório de Documentação

No repositório de documentação, na branch develop, está o código da página de documentação do GitHub Pages. A branch develop é protegida e só deve aceitar modificações por Pull Requests. As novas branches devem seguir a estrutura x-nome-da-issue.

2.3 Política de Issues

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

  • Bug report: para relatar problemas, erros, defeitos ou falhas.
  • História de usuário: para 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 devem seguir o padrão de mensagens especificado pelo Conventional Commits. As descrições dos commits devem ser em Português, referenciar a issue trabalhada e representar uma unidade de trabalho.

Exemplo:
#1 feat: adicionado serviço de autenticação

2.5 Pareamento

Para tarefas realizadas em pares, os commits precisam seguir o 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>

3. Referências

4. Histórico de versão

Data Descrição Autor
25/06/2024 Criação do documento Lucas Lima