Ir para o conteúdo

Política de Contribuição

Histórico de Revisão:

Data Versão Descrição Autor
06/05/2019 1.0 Criação e definição do documento de políticas de contribuição Luiz Guilherme

Política de Branches

Para a criação de branches siga os seguintes passos e modelo:

  • O nome da branch (NomeDaBranch) deverá ser uma abstração do nome da história de usuário a qual se refere.

  • Caso não tenha tag.

NomeDaBranch
  • Caso tenha tag, ela será o número da issue a qual a se refere a história de usuário.
Numero_da_issue-NomeDaBranch
  • O NomeDaBranch deverá ser escrito seguindo o padrão CamelCase
Numero_da_issue-NomeDaBranch

Exemplo prático

  • Sem tag
OurPolicies
  • Com tag
Issue_01-CamelCase

Política de Commits

Os commits devem seguir o seguinte padrão:

  • Deverão descrever sucintamente o que foi feito.
Descrição sucinta
  • Deverão ser escritas no presente do indicativo.
Cria um novo documento

  • A língua do commit deverá seguir como idioma padrão o inglês

  • Como o trabalho será codificado em inglês, os commits de código e documentação devem ser escritos em inglês.

Creates a new class
  • Caso tenha alguma tag referente, deverá ser usado o número da issue correspondente.
[Issue_01] Create a new class
  • A tag deverá ser separada por underline, nunca por espaço.

Exemplo prático

  • Commit referente a código ou documento com tag
[Issue_11] Updates bot answers

Política de Pull Requests

Para a criação de um pull request direcionado a branch master, deve-se seguir os seguintes passos:

Status

  • Titule o PR com a tag WIP (ou seja work in progress)

Descrição

  • Utilize o template de issue destinada ao pull request.
  • Lembrando que o pull request tem a branch base a master e a compare a branch que se deseja juntar.
  • Lembrando: assim que for realmente finalizado as alterações referentes ao pull request, deve-se retirar a tag WIP.

Imgur

Reviewers

  • Assinale os reviewers, ou seja, aqueles responsáveis à análise do pull request. Por exemplo, caso sua feature esteja relacionada a arquitetura do projeto, assinale o membro da equipe que desempenha esse papel.

Colaboradores

  • Assinale os colaboradores do pull request

Labels

  • Marque as labels relacionadas ao pull request. Geralmente será as mesmas assinaladas na issue referente.

Milestone

  • Marque a Milestone, ou seja, a sprint ou release atual.

Issue relacionada

  • Conecte a issue trabalhada neste pull request