Ir para o conteúdo

Padrões no Github

Commit

Utilizar commits que descrevam com poucas palavras e de forma clara, o que foi feito, escritos em português (utilizando acentos normalmente), com no máximo 65 caractéres, co-autores não são inclusos. Não serão utilizados verbos no gerúndio, um exemplo:

  • 👌 "Adição | Remoção | Implementação"
  • 👎 "Adicionando | Removendo | Implementando"

Branch

  • docs/nomeDocumento: documentação de algo
  • refactor/descricaoSimples: melhoria realizada
  • fix/descricaoSimples: resolução de um bug
  • feature/descricaoSimples: tarefa realizada
  • ata/dia_mes: adição de uma ata

Pull request (PR)

# Mudança tal

## Descrição 
Escreva uma breve descrição sobre o que o Pull Request resolve

[Nome da Issue](link_da_issue)

## Porque este Pull Request é necessário?
Descreva o motivo da realização do documento

## Critérios de aceitação
(Exemplos de critérios de aceitação)

1. [ ] Todas as informações necessárias estão presentes?
2. [ ] O documento está escrito de forma concisa?
3. [ ] A ortografia do documento está correta?

Resolve #(numero_da_issue)

Issue

Melhorias

## Descrição do problema atual
(Insira uma clara descrição sobre o problema atual)

## Descrição das melhorias propostas
(Descreva o que será melhorado)

1. [ ] '...'
2. [ ] '...'
3. [ ] '...'

Novo documento

## Descrição
Escreva uma breve descrição sobre o documento

## Critérios de aceitação
(Possíveis critérios)

1. [ ] O documento contempla o seu objetivo?
2. [ ] O documento está escrito de forma concisa?
3. [ ] A ortografia do documento está correta?
4. [ ] Há referências bibliográficas? Elas estão escritas no padrão correto?
5. [ ] O documento está devidamente versionado?

Reporte de bug

**Descreva o bug**
(Uma descrição clara sobre o bug)

**Como Reproduzir**
Passos para reproduzir este comportamento:
1. Vá para '...'
2. Clique em '....'
3. Role para baixo até '....'
4. Veja o erro

**Comportamento esperado**
(Uma descrição concisa sobre o que você esperava que acontecesse)


**Informações adicionais**
(Adicione qualquer outra informação que você julgue necessária)

Tarefa

## Descrição da tarefa
(descreva a tarefa de maneira clara)

## Lista de afazeres
1. [ ] '...'
2. [ ] '...'