Política: Nomenclatura de branches¶

A política de nomenclaturas de branches auxilia a garantir um fluxo de trabalho contínuo e padronizado, possibilitando o rastreamento das funcionalidades desenvolvidas e identificando as implementações disponibilizadas.

Branches Principais (ou Protegidas)¶

Um novo projeto deve iniciar com 3 branches principais e protegidas, onde somente os desenvolvedores responsáveis pela equipe devem ter acesso para manutenção e controle. Nenhuma das branches principais deve ser atualizada sem que haja uma solicitação de revisão por pares (Merge Request) para a branch de destino.

main → Responsável por manter o conteúdo do ambiente de Produção e deve ser considerada a branch mais estável dentre todas;
release → Responsável por manter o conteúdo do ambiente de Homologação;
develop → Responsável por manter o conteúdo do ambiente do Desenvolvimento. Também considerada a branch padrão para realização de testes de integração.

Nota: As branches principais podem ser customizadas a cada projeto, desde que esta alteração esteja devidamente formalizada no contrato social do projeto.

Branches de Trabalho (ou Derivadas)¶

As branches de trabalho, ou branches derivadas, são criadas em decorrência de uma nova funcionalidade, solicitação de mudança, bug-fix, ou qualquer outra situação em que seja necessária alteração do conteúdo do projeto. As branches de trabalho devem tratar única e exclusivamente do desenvolvimento às quais elas se destinam. Ou seja, se é uma branch que trata do incidente de número 122, o conteúdo alterado deve atender somente ao incidente de número 122. O mesmo vale para uma feature, alteração de documentação, refatoração, etc.

As branches para desenvolvimento devem seguir, necessariamente, os padrões abaixo e serem compostas de 3 partes:

Prefixos ou categoria da branch:
- feature/ → Nova funcionalidade ou componente que será adicionado ao projeto;
- bugfix/ → Correção de um bug encontrado em ambientes de testes, como Desenvolvimento (develop) ou Homologação (release);
- hotfix/ → Correção de um bug encontrado em ambiente de Produção, e que deve ser urgentemente tratado. De forma geral, esta branch descende diretamente da branch main.
Número da tarefa, issue ou card;
Breve descrição indicando o propósito da branch.

Exemplos de nomenclatura de branches de trabalho:¶

feature/377-cadastro-veiculos
bugfix/628-edicao-colaboradores
hotfix/192-busca-checklists