Ir para o conteúdo

Guia de contribuição

1. Introdução

Como contribuir para o projeto CD-MOJ ?

Siga as diretrizes abaixo.

2. Diretrizes para contribuir

2.1 Politica de branches

A politica de branchs adotada é realizar todas as mudanças diretamente na main.

OBS.: Repositório de documentação

Note que a temos duas branchs gh-deploy onde estão os arquivos de deploy, a aplicação após o build e main onde estão os arquivos source. Assim, as alterações devem ser feitas na branch main.

2.2 Politica de Issues

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

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

  • Fix: quando for descrever funcionalidades que precisam de revisão;

  • Doc: utilizado para criar ou alterar a documentação;

  • Feat: quando for descrever funcionalidades que precisam sem implementadas.

2.3 Política de Commit

Os commits deverão seguir o padrão proposto a seguir:

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

  • Um commit deve referenciar o caminho do principal arquivo alterado;

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

  • Um commit deve ser significativo, ou seja, deve explicar as alterações realizadas.

Exemplo: Issue 1: [Feat]: Botão que muda senha

git commit -m "<path do arquivo>: <descrição significativa>"

2.4 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.