VendeeDocs
Desenvolvimento

GitHub — Convencoes

Branches, commits e pull requests no repositorio Vendee

Repositorio

vendee-turborepo (privado) — hospedado na organizacao usevendee.

Branch Strategy

BranchUso
mainBranch de producao — sempre deployavel
feat/<ISSUE-ID>-descricaoNova funcionalidade
fix/<ISSUE-ID>-descricaoCorrecao de bug
refactor/<ISSUE-ID>-descricaoRefatoracao

Sem branch develop ou staging. O fluxo e direto: feature branch → PR → main.

Commit Messages

Formato convencional com ID da issue:

<prefixo>: descricao curta (ISSUE-ID)

Prefixos validos:

PrefixoUso
featFuncionalidade nova
fixCorrecao de bug
refactorRefatoracao sem mudanca de comportamento
choreTarefas de infra, build, deps
docsAlteracoes de documentacao
styleFormatacao, espacos, ponto-e-virgula
testAdicionar ou corrigir testes

Exemplos:

feat: add activity status border to deal card (CRM-1)
fix: deal card badge not updating on stage change (CRM-2)
refactor: extract pipeline filters into hook (CRM-4)

PR Template

## What
Brief description of what was implemented.

## Issue
Closes CRM-XX

## How to test
Steps to verify the implementation manually.

Regras

  • Uma issue = um branch = um PR. Nunca misturar issues no mesmo branch.
  • PR sempre aponta para main
  • Incluir Closes <ISSUE-ID> na descricao para as automacoes do Linear funcionarem
  • Nunca fazer push direto na main
  • Antes de abrir PR, verificar:
bun run check-types      # TypeScript
bun run lint             # ESLint (zero warnings)
bun run build            # Build completo

O texto Closes CRM-XX na descricao do PR e o que aciona a automacao no Linear para mover a issue para Done quando o PR for mergeado.

On this page