Skip to content

Commit bc27ad9

Browse files
committed
docs: update branch workflow guidelines in README
1 parent 62bb51e commit bc27ad9

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,54 @@ Bot de automacao para buscar vagas no LinkedIn com foco em Brasil remoto e expor
3535
- Desenvolvimento: `npm run dev`
3636
- Hot reload: `npm run run`
3737

38+
## Fluxo de branches (obrigatorio)
39+
40+
Este repositorio usa o seguinte fluxo:
41+
42+
- `master`: codigo estavel (base principal)
43+
- `develop`: branch de integracao
44+
- `feature/*`: branch temporaria de trabalho
45+
46+
Regra principal para evitar confusao:
47+
48+
- A `feature` sempre nasce da `master`
49+
- Ao finalizar, a `feature` deve abrir PR para `develop`
50+
- `master` nao deve receber trabalho direto de feature no dia a dia
51+
52+
### Passo a passo
53+
54+
1. Atualize sua `master` local com o remoto
55+
2. Crie sua `feature` a partir da `master`
56+
3. Trabalhe localmente e faca commits na `feature`
57+
4. Publique a `feature` no remoto
58+
5. Abra Pull Request com destino em `develop`
59+
60+
Exemplo:
61+
62+
```bash
63+
git checkout master
64+
git pull origin master
65+
66+
git checkout -b feature/nome-da-feature
67+
68+
# faz alteracoes...
69+
git add .
70+
git commit -m "feat: descreve a feature"
71+
72+
git push -u origin feature/nome-da-feature
73+
```
74+
75+
No GitHub, abra o PR assim:
76+
77+
- `base`: `develop`
78+
- `compare`: `feature/nome-da-feature`
79+
80+
### Importante
81+
82+
- Nao use `develop` como base para criar `feature` neste projeto
83+
- Nao aponte PR de `feature` direto para `master`
84+
- `master` deve ser atualizada a partir de `develop` apenas no momento de release
85+
3886
## Variaveis de ambiente
3987

4088
Todas sao opcionais.

0 commit comments

Comments
 (0)