Skip to content

Políticas

Versionamento

Data Versão Descrição Autores
27/07/2021 1.0 Documento Lucas Gabriel
05/08/2021 1.1 Modificar formatação e padrão de commits Davi Antônio

Introdução

Esse documento contém os padrões, decididos pela equipe, para organização a cerca das contribuições no projeto.

Nomeação de arquivos e pastas

Os arquivos e pastas deverão utilizar o padrão snake_case para nomeação.

Commits

Os commits devem ser escritos em português brasileiro, e devem mencionar no corpo o número da issue ao qual está relacionado. 
1
git commit

1
2
3
4
5
6
7
Escrever mensagem de commit padrão

A definição de uma mensagem de commit padrão é importante para garantir
a padronização do processo de desenvolvimento.

Por isso, definiu-se esse commit como o padrão, o que impacta o
progresso na issue #<número da issue>.
Os commits com de tarefas em pares devem conter o Co-Autor como mostrado no exemplo abaixo: 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
Título do commit

Parágrafo explicativo 1.

Parágrafo explicativo 2.

Parágrafo explicativo n.

- item de lista 1
- item de lista 2
- item de lista n

Co-authored-by: nome-autor <email@xxx.com>
Co-authored-by: nome-autor2 <email2@xxx.com>

Branches

As Branches devem ser nomeadas conforme especificado nesse documento.

  • Branch que mantém uma versão estável do projeto 

    1
    master

  • Branch que mantém uma versão atualizada do projeto 

    1
    devel

  • Branch para documentação

1
docs/nome_do_documento
  • Branch para feature (funcionalidade)

1
feature/nome_da_feature
* Branch para bug e correções

1
fix/nome_da_feature_corrigida

Pull Request(PR)

Os Pull Requests (PR) devem ser escritos em português brasileiro, de forma clara e suscinta.
  • Título: Nome que descreva minimamente do que se trata
  • Descrição: descrição clara, sobre o que o PR resolve, e as issues relacionadas

Template PR

1
2
3
4
5
Título do PR

Esse PR resolveu as issues #X #Y:
* Tarefa realizada
* Tarefa realizada 2

Importante

  • O Pull Request só pode ser aceito após revisão de membros que não participaram no desenvolvimento da branch

Issues

  • Título: uma breve descrição da tarefa a ser realizada
  • Descrição: uma descrição detalhada sobre o que deve ser feito para realizar a issue
  • Critérios de aceitação: definir tarefas essenciais para aceitação da issue

Importante

  • Todas as issues devem ter no minimo um critério de aceitação
  • As issues dever respeitar a estrutura do template

Template Issue

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Título

### Descrição
Descrição escrita sobre a issue

### Critérios de aceitação

- [ ] Critério 1
- [ ] Critério 2
- [ ] Critério 3