| ... | ... | @@ -28,12 +28,12 @@ GitFlow é o processo de contribuição para os projetos utilizando a ferramenta |
|
|
|
|
|
|
|
## 📌 Commits
|
|
|
|
|
|
|
|
Estamos utilizando um padrão inspiraado 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).
|
|
|
|
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 três números, separados por dois hífens (ex. us-1-2-3);
|
|
|
|
- Mensagens de commit não podem ultrapassar 72 caracteres e devem ser escritas no imperativo;
|
|
|
|
- Tipo é conforme abaixo:
|
|
|
|
- Escopo é a abreviação da _user story_ com dois números, separados por hífen (ex. `us-1-1`);
|
|
|
|
- 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:
|
|
|
|
|
|
|
|
### 🔹 Tipos de commit
|
|
|
|
|
| ... | ... | @@ -48,14 +48,14 @@ Estamos utilizando um padrão inspiraado no [Conventional Commits](https://www.c |
|
|
|
|
|
|
|
### Exemplos
|
|
|
|
|
|
|
|
- `feat(us-1-2-1): Do something`
|
|
|
|
- `fix(no-us): something case sensitive`
|
|
|
|
- `feat(us-2-1): Did something`
|
|
|
|
- `fix(no-us): Re-did that thing`
|
|
|
|
|
|
|
|
### 🔹 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**.
|
|
|
|
- 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**.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
| ... | ... | @@ -65,15 +65,15 @@ As branches para desenvolvimento devem ser feitas a partir da `develop`. Os nome |
|
|
|
|
|
|
|
### Exemplos
|
|
|
|
|
|
|
|
- `us-5-2-4/issue-naming`
|
|
|
|
- `us-2-4/issue-naming`
|
|
|
|
- `no-us/writing-something-here`
|
|
|
|
|
|
|
|
### 🔹 Regras
|
|
|
|
|
|
|
|
- **`us-X-Y-Z/descricao`** → Para tarefas relacionadas a uma User Story (US). Os números `X`, `Y` e `Z` representam a ID da US.
|
|
|
|
- **`no-us/descricao`** → 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 **letras minúsculas**.
|
|
|
|
- A descrição deve ser escrita em inglês e em **letras minúsculas**.
|
|
|
|
- A descrição deve ser curta e clara.
|
|
|
|
|
|
|
|
---
|
| ... | ... | |
