Skip to content

Commit bc2277b

Browse files
mauromattos00jhonyeduardo
authored andcommitted
docs(contributing): remove tags de links do arquivo
Utiliza os ids gerados pelos próprios headings
1 parent 7630fa5 commit bc2277b

File tree

1 file changed

+15
-33
lines changed

1 file changed

+15
-33
lines changed

CONTRIBUTING.md

+15-33
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,35 @@
22

33
## Conteúdo
44

5-
- [Introdução](#introduction)
6-
- [Fluxo](#flow)
7-
- [Regras para criação de *branches*](#branches)
8-
- [Regras para criação de *commits*](#commits)
9-
- [Tipo](#type)
10-
- [Escopo](#scope)
11-
- [Descrição curta](#short-description)
12-
- [Corpo](#body)
13-
- [Rodapé](#footer)
5+
- [Introdução](#introdução)
6+
- [Fluxo](#fluxo)
7+
- [Regras para criação de *branches*](#regras-para-criação-da-branch)
8+
- [Regras para criação de *commits*](#regras-para-criação-de-commits)
9+
- [Tipo](#tipo)
10+
- [Escopo](#escopo)
11+
- [Descrição curta](#descrição-curta)
12+
- [Corpo](#corpo)
13+
- [Rodapé](#rodapé)
1414
- [*Breaking Changes*](#breaking-changes)
15-
- [Exemplos de descrições de commits completos](#commit-example)
16-
- [Regras para criação de *Pull Requests*](#pull-requests)
15+
- [Exemplos de descrições de commits completos](#exemplos-de-descrições-de-commits-completos)
16+
- [Regras para criação de *Pull Requests*](#regras-para-criação-de-pull-requests)
1717
- [Componente](#componente)
18-
- [Número da ISSUE](#issue-number)
18+
- [Número da ISSUE](#número-da-issue)
1919
- [*PR Checklist*](#pr-checklist)
20-
- [Qual o comportamento atual?](#current-behavior)
21-
- [Qual o novo comportamento?](#new-behavior)
22-
- [Simulação](#simulation)
20+
- [Qual o comportamento atual?](#qual-o-comportamento-atual)
21+
- [Qual o novo comportamento?](#qual-o-novo-comportamento)
22+
- [Simulação](#simulação)
2323

2424

25-
<a id="introduction"></a>
2625
## Introdução
2726

2827
Este guia tem por objetivo definir as regras para criação de *Branches*, *Pull Requests* e *Commits* no projeto PO UI.
2928
Para seguir o guia é fundamental o conhecimento da [ferramenta Git](https://git-scm.com/book/en/v2).
3029

31-
<a id="flow"></a>
3230
## Fluxo
3331

3432
O fluxo para o desenvolvimento e criação de issues e Pull Requests está definido em [Contribuindo para o PO UI](https://po-ui.io/guides/development-flow)
3533

36-
<a id="branches"></a>
3734
## Regras para criação da *Branch*
3835

3936
Antes de criar uma nova *branch* deve-se assegurar de estar na *branch master* do projeto.
@@ -74,7 +71,6 @@ Exemplo:
7471
git checkout -b po-button/fulano
7572
```
7673

77-
<a id="commits"></a>
7874
## Regras para criação de *Commits*
7975

8076
A descrição dos *commits* podem ser feitos em português ou inglês.
@@ -92,7 +88,6 @@ Deve-se seguir um padrão para criação dos *commits*:
9288
```
9389
Agora vamos detalhar melhor o que deve ser descrito em cada parte:
9490

95-
<a id="type"></a>
9691
### Tipo
9792

9893
Deve ser utilizado um dos tipos descritos abaixo conforme o objetivo da alteração:
@@ -107,7 +102,6 @@ Deve ser utilizado um dos tipos descritos abaixo conforme o objetivo da alteraç
107102

108103
> Nunca colocar espaço entre a descrição do tipo e a abertura de parênteses do escopo.
109104
110-
<a id="scope"></a>
111105
### Escopo
112106

113107
No escopo deverá ser definido o nome do componente ou serviço diretamente afetado pelo *commit*, caso mais de um componente seja afetado, deve-se definir o principal. Não deve ser utilizado o prefixo na nomenclatura, por exemplo:
@@ -120,7 +114,6 @@ Errados:
120114

121115
> Sempre deve estar entre parênteses e após o fechamento do parênteses deve-se colocar dois pontos e um espaço.
122116
123-
<a id="short-description"></a>
124117
### Descrição curta
125118

126119
- Deve-se colocar uma breve descrição do que foi feito no *commit*.
@@ -149,7 +142,6 @@ Adicionada nova funcionalidade.
149142
Removida variável não mais utilizada no componente po-button devido a quebra no uso do mesmo.
150143
```
151144

152-
<a id="body"></a>
153145
### Corpo
154146

155147
- Deve-se utilizar o modo imperativo na descrição.
@@ -158,7 +150,6 @@ Removida variável não mais utilizada no componente po-button devido a quebra n
158150

159151
> Antes da declaração do corpo deve-se deixar uma linha em branco.
160152
161-
<a id="footer"></a>
162153
### Rodapé
163154

164155
No rodapé deve-se colocar a palavra `Fixes` e em seguida o número da ISSUE atendida. Exemplos:
@@ -180,7 +171,6 @@ Fixes #235, #456, #665
180171

181172
> Antes da declaração do rodapé deve-se deixar uma linha em branco.
182173
183-
<a id="breaking-changes"></a>
184174
### *Breaking Changes*
185175

186176
- As *breaking changes* devem ser declaradas no rodapé uma linha após a declaração do *Fixes*.
@@ -189,7 +179,6 @@ Fixes #235, #456, #665
189179
- Deve-se quebrar linha a cada 72 caracteres para que a mesma não seja cortada no GitHub.
190180
- O tipo do item de *breaking change* depende do que está sendo implementado, por exemplo, caso for apenas removida alguma propriedade o tipo deve ser definido como *refactor*, caso ao corrigir um problema seja gerado um *breaking change* então o tipo deve ser definido como *fix*.
191181

192-
<a id="commit-example"></a>
193182
### Exemplos de descrições de *commits* completos
194183

195184
Sem *Breaking Changes*:
@@ -222,7 +211,6 @@ Depois:
222211
<po-button class="po-md-4"></po-button>
223212
```
224213

225-
<a id="pull-requests"></a>
226214
## Regras para criação de *Pull Requests*
227215

228216
Antes de criar a *Pull Request* é importante verificar se algumas perguntas foram respondidas:
@@ -234,7 +222,6 @@ Antes de criar a *Pull Request* é importante verificar se algumas perguntas for
234222

235223
Após essas verificações e tudo estando correto basta gerar a *Pull Request*. Por padrão virá um template onde deverão ser preenchidos alguns requisitos citados abaixo:
236224

237-
<a id="componente"></a>
238225
### Componente
239226

240227
Esse texto deve ser substituído pelo nome do componente diretamente afetado pela alteração gerada na *Pull Request*.
@@ -247,7 +234,6 @@ po-modal
247234
po-button
248235
```
249236

250-
<a id="issue-number"></a>
251237
### Número da ISSUE
252238

253239
Esse texto deve ser substituído pelo número da ISSUE gerada no Jira ou no GitHub.
@@ -260,7 +246,6 @@ DTHFUI-577
260246
#334
261247
```
262248

263-
<a id="pr-checklist"></a>
264249
### PR Checklist
265250

266251
Deve-se adicionar um `x` dentro dos colchetes sem deixar espaço em cada um dos itens que forem alterados na *Pull Request*.
@@ -273,7 +258,6 @@ Exemplo:
273258
- [x] Samples
274259
```
275260

276-
<a id="current-behavior"></a>
277261
### Qual o comportamento atual?
278262

279263
Deve-se descrever o atual comportamento e o motivo que levou a gerar a alteração.
@@ -284,7 +268,6 @@ Exemplo:
284268
O po-modal não está permitindo definir uma largura maior que 768px. Está gerando problema pois ao criar um formulário maior gera-se um scroll dificultando a visualização do cliente.
285269
```
286270

287-
<a id="new-behavior"></a>
288271
### Qual o novo comportamento?
289272

290273
Deve-se descrever o novo comportamento gerado, bem como o que e como foi alterado para solucionar o motivo que foi descrito no comportamento atual.
@@ -296,7 +279,6 @@ Criação do novo valor "full" na propriedade p-size.
296279
Este valor serve para poder deixar o po-modal ter o tamanho conforme o conteúdo sem a limitação de tamanho.
297280
```
298281

299-
<a id="simulation"></a>
300282
### Simulação
301283

302284
Aqui deve-se descrever sugestões de formas de validar a alteração gerada.

0 commit comments

Comments
 (0)