Branch pattern - ESG-Project/documentation GitHub Wiki

Este documento define as convenções de nomenclatura de branches para o repositório. Seguir essas convenções ajuda a manter o repositório organizado e facilita a colaboração entre os desenvolvedores.

Estrutura das Branches

As branches devem seguir o seguinte formato:

<tipo>/<ID da issue>-<descrição-curta>

Tipos de Branches

  • feature: Para novas funcionalidades.
  • bugfix: Para correções de bugs.
  • hotfix: Para correções urgentes em produção.
  • release: Para preparar uma nova versão de lançamento.
  • experiment: Para experimentos ou provas de conceito.
  • chore: Para tarefas de manutenção ou ajustes menores que não se encaixam nos outros tipos.

Exemplos

  • feature/SUASSU-01
  • bugfix/SUASSU-02
  • hotfix/SUASSU-03
  • release/1.0.0-preparacao
  • experiment/SUASSU-04
  • chore/SUASSU-05

Diretrizes Gerais

  1. Use um tipo apropriado: Escolha o tipo de branch que melhor descreve o propósito da sua alteração.
  2. Inclua o ID da issue: Utilize o ID da issue relevante para rastrear a alteração. Exemplo: 01 para a issue #01.
  3. Mantenha a descrição curta e clara: A descrição deve ser uma breve frase que resume a alteração. Utilize hifens para separar palavras.
  4. Use letras minúsculas: Todas as letras na descrição devem ser minúsculas.
  5. Evite caracteres especiais: Utilize apenas letras, números e hifens.

Exemplos de Branches

Branch para uma Nova Funcionalidade

feature/SUASSU-01

Branch para Correção de Bug

bugfix/SUASSU-02

Branch para Correção Urgente em Produção

hotfix/SUASSU-03

Branch para Preparação de Lançamento

release/1.0.0-preparacao

Branch para Experimento

experiment/SUASSU-04

Branch para Tarefa de Manutenção

chore/SUASSU-05

Seguir essas convenções ajudará a manter o repositório organizado e facilitará a colaboração e o gerenciamento de código.

⚠️ **GitHub.com Fallback** ⚠️