You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-33
Original file line number
Diff line number
Diff line change
@@ -2,38 +2,35 @@
2
2
3
3
## Conteúdo
4
4
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é)
14
14
-[*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)
17
17
-[Componente](#componente)
18
-
-[Número da ISSUE](#issue-number)
18
+
-[Número da ISSUE](#número-da-issue)
19
19
-[*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)
23
23
24
24
25
-
<aid="introduction"></a>
26
25
## Introdução
27
26
28
27
Este guia tem por objetivo definir as regras para criação de *Branches*, *Pull Requests* e *Commits* no projeto PO UI.
29
28
Para seguir o guia é fundamental o conhecimento da [ferramenta Git](https://git-scm.com/book/en/v2).
30
29
31
-
<aid="flow"></a>
32
30
## Fluxo
33
31
34
32
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)
35
33
36
-
<aid="branches"></a>
37
34
## Regras para criação da *Branch*
38
35
39
36
Antes de criar uma nova *branch* deve-se assegurar de estar na *branch master* do projeto.
@@ -74,7 +71,6 @@ Exemplo:
74
71
git checkout -b po-button/fulano
75
72
```
76
73
77
-
<aid="commits"></a>
78
74
## Regras para criação de *Commits*
79
75
80
76
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*:
92
88
```
93
89
Agora vamos detalhar melhor o que deve ser descrito em cada parte:
94
90
95
-
<aid="type"></a>
96
91
### Tipo
97
92
98
93
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ç
107
102
108
103
> Nunca colocar espaço entre a descrição do tipo e a abertura de parênteses do escopo.
109
104
110
-
<aid="scope"></a>
111
105
### Escopo
112
106
113
107
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:
120
114
121
115
> Sempre deve estar entre parênteses e após o fechamento do parênteses deve-se colocar dois pontos e um espaço.
122
116
123
-
<aid="short-description"></a>
124
117
### Descrição curta
125
118
126
119
- Deve-se colocar uma breve descrição do que foi feito no *commit*.
@@ -149,7 +142,6 @@ Adicionada nova funcionalidade.
149
142
Removida variável não mais utilizada no componente po-button devido a quebra no uso do mesmo.
150
143
```
151
144
152
-
<aid="body"></a>
153
145
### Corpo
154
146
155
147
- 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
158
150
159
151
> Antes da declaração do corpo deve-se deixar uma linha em branco.
160
152
161
-
<aid="footer"></a>
162
153
### Rodapé
163
154
164
155
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
180
171
181
172
> Antes da declaração do rodapé deve-se deixar uma linha em branco.
182
173
183
-
<aid="breaking-changes"></a>
184
174
### *Breaking Changes*
185
175
186
176
- 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
189
179
- Deve-se quebrar linha a cada 72 caracteres para que a mesma não seja cortada no GitHub.
190
180
- 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*.
191
181
192
-
<aid="commit-example"></a>
193
182
### Exemplos de descrições de *commits* completos
194
183
195
184
Sem *Breaking Changes*:
@@ -222,7 +211,6 @@ Depois:
222
211
<po-button class="po-md-4"></po-button>
223
212
```
224
213
225
-
<aid="pull-requests"></a>
226
214
## Regras para criação de *Pull Requests*
227
215
228
216
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
234
222
235
223
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:
236
224
237
-
<aid="componente"></a>
238
225
### Componente
239
226
240
227
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
247
234
po-button
248
235
```
249
236
250
-
<aid="issue-number"></a>
251
237
### Número da ISSUE
252
238
253
239
Esse texto deve ser substituído pelo número da ISSUE gerada no Jira ou no GitHub.
@@ -260,7 +246,6 @@ DTHFUI-577
260
246
#334
261
247
```
262
248
263
-
<aid="pr-checklist"></a>
264
249
### PR Checklist
265
250
266
251
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:
273
258
- [x] Samples
274
259
```
275
260
276
-
<aid="current-behavior"></a>
277
261
### Qual o comportamento atual?
278
262
279
263
Deve-se descrever o atual comportamento e o motivo que levou a gerar a alteração.
@@ -284,7 +268,6 @@ Exemplo:
284
268
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.
285
269
```
286
270
287
-
<aid="new-behavior"></a>
288
271
### Qual o novo comportamento?
289
272
290
273
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.
296
279
Este valor serve para poder deixar o po-modal ter o tamanho conforme o conteúdo sem a limitação de tamanho.
297
280
```
298
281
299
-
<aid="simulation"></a>
300
282
### Simulação
301
283
302
284
Aqui deve-se descrever sugestões de formas de validar a alteração gerada.
0 commit comments