Skip to content

Commit cfcc7ff

Browse files
authored
docs: update README with development workflow and branching guidelines (#31)
2 parents 2f16cb8 + 113ce8b commit cfcc7ff

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,33 @@
33
Uma plataforma interna para transformar arquivos XLSX de vagas em uma experiencia visual rapida, filtravel e pronta para decisao.
44

55

6+
---
7+
8+
## ⚠️ IMPORTANTE: Fluxo de Development e Branching
9+
10+
> **Padrão de Desenvolvimento - LEIA ATENTAMENTE**
11+
>
12+
> O fluxo correto de trabalho deve seguir EXATAMENTE essa sequência:
13+
>
14+
> 1. **Abrir uma Issue de Melhorias** - Descreva a feature/bug a implementar
15+
> 2. **Criar branch `feature/` a partir de `master`** - Nomenclatura: `feature/numero-da-issue-descricao`
16+
> 3. **Desenvolver e testar localmente** - Faça commits regulares na feature
17+
> 4. **Abrir Pull Request** - Apontar a feature para a branch `develop` (NÃO para master)
18+
> 5. **Code Review e Merge em `develop`** - Após aprovação, merge e teste na develop
19+
> 6. **Abrir PR de `develop` para `master`** - Somente features testadas e aprovadas
20+
> 7. **Merge em `master`** - Release final da feature
21+
>
22+
> **Resumo das branches:**
23+
> - `master`: Produção (releases finais e estáveis)
24+
> - `develop`: Staging (features em validação)
25+
> - `feature/*`: Branches de desenvolvimento (sempre partir de master)
26+
>
27+
> **NÃO faça:**
28+
> - Commits diretos em master ou develop
29+
> - Pull requests diretamente para master (primeira PR deve apontar para develop)
30+
> - Features sem issue associada
31+
32+
---
633

734
## Diretriz de Design (Obrigatoria)
835

@@ -211,7 +238,6 @@ Meta minima de cobertura:
211238
- statements >= 80%
212239
- functions >= 80%
213240
- branches >= 80%
214-
215241
Comandos de cobertura:
216242

217243
```bash
@@ -237,7 +263,6 @@ Subir frontend + backend:
237263
docker compose up --build
238264
```
239265

240-
Subir em background:
241266

242267
```bash
243268
docker compose up --build -d

0 commit comments

Comments
 (0)