Padronização de Branches

[LeticiaAires]

Descrição

Configurar branches de acordo com o worflow definido

Tarefas

• [x] Debater e definir workflow a ser seguido
• [x] Instaurar padrão para criação de branches

Critérios de aceitação

• [x] Tópico deve ser discutido
• [x] Issue deve ser revisada e aprovada

[Matheuspimentell]

O grupo 3 pode ficar responsável por esta issue ?

[lucasqueiroz23]

O grupo 3 pode ficar responsável por esta issue ?

Por mim, tudo bem!

[Matheuspimentell]

Nas políticas de contribuição do Acácia, consta uma política de criação de branches.

https://fga-eps-mds.github.io/2019.2-Acacia/#/policies

[Matheuspimentell]

Políticas de branch

As branches criadas neste repositório devem seguir os padrões a seguir:

Uma breve explicação sobre o fluxo de trabalho:

main

• A branch main representa uma versão estável do produto, contendo código já testado, versionado e revisado, pronto para ser entregue ao usuário final. Esta branch partirá através da branch develop através de pull requests aprovados ao final de cada release.

Regras:

1. Existe apenas UMA branch main.
2. Não são permitidos commits feitos diretamente na branch main.

develop

• A branch develop contém a versão mais atualizada do código que está sendo desenvolvido. Esta branch está sempre sincronizada com a main e é base para as branches feature.

Regras:

1. Existe apenas UMA branch develop.
2. Esta branch sempre é mesclada à branch main.

feature

• As branches feature representam as funcionalidades do sistema a serem desenvolvidas. Elas devem ter a branch develop como sua origem e fim.

Regras de nomenclatura:

feature/(#Id-da-issue)-título-da-issue

release

• A branch release representa o conjunto de funcionalidades provenientes de um ponto específico da branch develop. Esta branch contém funcionalidades prontas que, provavelmente, estarão presentes na próxima versão estável do produto. Apenas bug fixes são permitidos nesta branch.

Regras:

1. Esta branch é criada sempre a partir da branch develop.
2. Esta branch é mesclada às branches develop e main.
3. Esta branch aceita apenas mesclagens de branches do tipo bugfix.

Regras de nomenclatura:

release/vNúmero-da-versão

bugfix

• As branches do tipo bugfix são utilizadas para implementar soluções para bugs, encontrados através de testes realizados em releases específicas, na branch release. Isso significa que a branch bugfix deve ter a branch release como sua origem e fim.

Regras:

1. Esta branch sempre é criada a partir da branch release.
2. Esta branch sempre é mesclada à branch release.

Regras de nomenclatura:

bugfix/(#Id-da-issue)-título-da-issue

hotfix

• A branch hotfix é utilizada para implementar soluções para problemas urgentes encontrados no ambiente de produção. Isso significa que esta branch deve ter a branch main como sua origem e fim.

Regras:

1. Esta branch sempre é criada a partir da branch main.
2. Esta branch sempre é mesclada à branch main.

Regras de nomenclatura:

hotfix/(#Id-da-issue)-título-da-issue

[gabrielm2q]

O documento no comentário acima está pronto para ser revisado.

[joaopaulob3]

Só um comentário, pessoal: acredito que o documento elaborado devesse ser colocado no nosso docs. Além disso, é importante corrigir os links quebrados do contributing relativo à política de branchs e a política de commits.

[Matheuspimentell]

O documento estará no docs do repositório assim que for revisado. E com relação aos links quebrados, iremos corrigir. Agora, gostaria de perguntar se você conseguiu revisar o documento acima pra nós.

[guigudf]

O documento foi revisado e está condizente com o git-flow utilizado como base. Foi criado uma branch develop, como dito no documento, e solicito começarmos a trabalhar nela a partir da sprint 6

[Matheuspimentell]

Obrigado pela revisão, @guigudf irei fechar a issue e upar o doc

[Matheuspimentell]

O documento revisado se encontra aqui.