|
|
|
# 🌱 Padrões de Branch e Commit
|
|
|
|
|
|
|
|
## 📌 Branches
|
|
|
|
|
|
|
|
Os nomes das branches devem seguir o seguinte padrão:
|
|
|
|
[us|no-ref]-<id_da_us>/descricao
|
|
|
|
|
|
|
|
### Exemplos:
|
|
|
|
- `us-01/issue-naming`
|
|
|
|
- `no-ref/writing-something-here`
|
|
|
|
|
|
|
|
### 🔹 Regras:
|
|
|
|
- **`us-XX/descricao`** → Para tarefas relacionadas a uma User Story (US). O número `XX` representa a ID da US.
|
|
|
|
- **`no-ref/descricao`** → Para alterações sem uma US específica.
|
|
|
|
- Utilize **hífens (-) para separar palavras** na descrição da branch.
|
|
|
|
- A descrição deve ser curta e clara.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## 📌 Commits
|
|
|
|
|
|
|
|
Os commits devem seguir o padrão:
|
|
|
|
(<us|no-ref>): descrição resumida do que foi feito
|
|
|
|
|
|
|
|
### Exemplos:
|
|
|
|
- `feat(us-01): I did something`
|
|
|
|
- `fix(no-ref): something case sensitive`
|
|
|
|
|
|
|
|
### 🔹 Tipos de commit:
|
|
|
|
| Tipo | Descrição |
|
|
|
|
|---------|----------|
|
|
|
|
| `feat` | Adição de uma nova funcionalidade |
|
|
|
|
| `fix` | Correção de um bug |
|
|
|
|
| `refactor` | Refatoração de código (sem mudanças na funcionalidade) |
|
|
|
|
| `chore` | Tarefas de manutenção (ex.: atualização de dependências) |
|
|
|
|
| `docs` | Alterações na documentação |
|
|
|
|
| `test` | Adição ou modificação de testes |
|
|
|
|
| `style` | Mudanças de formatação e estilo (sem afetar funcionalidade) |
|
|
|
|
|
|
|
|
### 🔹 Regras:
|
|
|
|
- O **tipo** do commit deve estar em **minúsculas**.
|
|
|
|
- O identificador da **US** deve estar **entre parênteses**.
|
|
|
|
- A **descrição** deve ser breve e começar com **letra minúscula**.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## 🎯 Exemplo de Workflow
|
|
|
|
|
|
|
|
1. Criar uma branch para a tarefa:
|
|
|
|
```bash
|
|
|
|
git checkout -b us-42/create-login |
|
|
\ No newline at end of file |
