... | ... | @@ -23,8 +23,7 @@ GitFlow é o processo de contribuição para os projetos utilizando a ferramenta |
|
|
|
|
|
Estamos utilizando um padrão inspirado no [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), que é baseado em [@commitlint/config-conventional](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).
|
|
|
|
|
|
- Os commits devem seguir `<tipo>(<escopo>): <mensagem>`;
|
|
|
- Escopo é a abreviação da _user story_ com dois números, separados por hífen (ex. `us-1-1`);
|
|
|
- Os commits devem seguir `<tipo>: <mensagem>`;
|
|
|
- Mensagens de commit não podem ultrapassar 72 caracteres e devem ser em inglês e escritas no pretérito perfeito;
|
|
|
- Tipo é conforme a tabela abaixo:
|
|
|
|
... | ... | @@ -41,30 +40,30 @@ Estamos utilizando um padrão inspirado no [Conventional Commits](https://www.co |
|
|
|
|
|
### Exemplos
|
|
|
|
|
|
- `feat(us-2-1): Did something`
|
|
|
- `fix(no-us): Re-did that thing`
|
|
|
- `feat: Did something`
|
|
|
- `fix: Re-did that thing`
|
|
|
|
|
|
### 🔹 Regras
|
|
|
|
|
|
- O **tipo** do commit deve estar em **letras minúsculas**.
|
|
|
- O identificador da **us** deve estar **entre parênteses**, em *letras minúsculas*.
|
|
|
- A _descrição_ deve ser breve e começar com **letra maiúscula**.
|
|
|
|
|
|
---
|
|
|
|
|
|
## 📌 Branches
|
|
|
|
|
|
As branches para desenvolvimento devem ser feitas a partir da `develop`. Os nomes de branch devem seguir `<escopo>/<descrição>`, onde a descrição **deve ser breve**, conter apenas letras minúsculas e utilizar hífens no lugar de espaços. Escopo é definido conforme dito anteriormente.
|
|
|
As branches para desenvolvimento devem ser feitas a partir da `develop`. Os nomes de branch devem seguir `<escopo>_<descrição>`, onde a descrição **deve ser breve**, conter apenas letras minúsculas e utilizar hífens no lugar de espaços. Escopo é definido como a abreviação da _user story_ com dois números, separados por hífen (ex. `us-1-1`);
|
|
|
.
|
|
|
|
|
|
### Exemplos
|
|
|
|
|
|
- `us-2-4/issue-naming`
|
|
|
- `no-us/writing-something-here`
|
|
|
- `us-2-4_issue-naming`
|
|
|
- `no-us_writing-something-here`
|
|
|
|
|
|
### 🔹 Regras
|
|
|
|
|
|
- **`us-X-Y/description`** → Para tarefas relacionadas a uma User Story (US). Os números `X` e `Y` representam a ID da US.
|
|
|
- **`no-us/description`** → Para alterações sem uma US específica.
|
|
|
- **`us-X-Y_description`** → Para tarefas relacionadas a uma User Story (US). Os números `X` e `Y` representam a ID da US.
|
|
|
- **`no-us_description`** → Para alterações sem uma US específica.
|
|
|
- Utilize **hífens (-) para separar palavras** na descrição da branch.
|
|
|
- A descrição deve ser escrita em inglês e em **letras minúsculas**.
|
|
|
- A descrição deve ser curta e clara.
|
... | ... | |