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: .github/CONTRIBUTING.md
+30-27Lines changed: 30 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,8 @@
13
13
14
14
**Esse documento apresenta todas as informações necessárias para que possa colaborar com o projeto de forma independente.**
15
15
16
+
> Não tenha receio em contribuir se achar muito complexo as etapas para contribuir. **Basta pedir apoio em issue ou PR e receberá auxílio no que precisar.**
17
+
16
18
Você pode contribuir de várias maneiras, sendo as mais conhecidas as seguintes:
17
19
18
20
- Localizando e relatando bugs
@@ -31,12 +33,38 @@ Você pode contribuir de várias maneiras, sendo as mais conhecidas as seguintes
31
33
4. Faça o seu commit usando `npm run commit`;
32
34
5. Envie um [pull request](https://help.github.com/articles/about-pull-requests/);
33
35
6. Aguarde o resultado das validações realizadas na integração contínua. Caso haja alguma quebra, analise e faça as correções necessárias.
34
-
### Pull Requests que não passarem nas validações da integração contínua não serão revisados.
35
36
36
37
### Legenda
37
38
#### 💥 > Validação realizada na integração contínua e entrega contínua
Usamos o [standard](https://www.npmjs.com/package/standard) como linter e formatter do código e [lint-staged](https://www.npmjs.com/package/lint-staged) para forçar lint das alterações que estão em staged do git.
46
+
47
+
Execute `npm run lint` para padronizar os arquivos.
48
+
49
+
Execute `npm run lint:fix` para corrigir automaticamente os problemas encontrados pelo lint.
50
+
51
+
> O commit é abortado caso esse padrão não seja seguido
As mensagens de commit devem seguir o padrão do _conventional commit_.
59
+
60
+
Para saber mais, acesse esses links:
61
+
-[Especificação do Conventional Commit](https://www.conventionalcommits.org/)
62
+
-[Regras do @commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional).
63
+
64
+
Execute `npm run commit` para ter um painel interativo que permite seguir o padrão de commit de forma fácil.
65
+
66
+
> O commit é abortado caso esse padrão não seja seguido
67
+
40
68
## 💥 Testes de API
41
69
42
70
Os testes são importantes para garantir a integridade do projeto a cada alteração realizada. É importante que atente de que a sua alteração necessite de novos testes ou adequação nos já existentes.
@@ -63,32 +91,7 @@ Usamos o [nyc](https://www.npmjs.com/package/nyc) para validar a cobertura de c
63
91
64
92
Para validar a cobertura localmente execute os testes. É apresentado um report no terminal informando a cobertura de todos os arquivos em `/src` (exceto `server.js`). Se algum dos arquivos não estiver com 100% em todas as métricas crie os testes necessários.
Usamos o [standard](https://www.npmjs.com/package/standard) como linter e formatter do código.
71
-
72
-
Execute `npm run lint` para padronizar os arquivos.
73
-
74
-
Execute `npm run lint:fix` para corrigir automaticamente os problemas encontrados pelo lint.
75
-
76
-
> O commit é abortado caso esse padrão não seja seguido
As mensagens de commit devem seguir o padrão do _conventional commit_.
84
-
85
-
Para saber mais, acesse esses links:
86
-
-[Especificação do Conventional Commit](https://www.conventionalcommits.org/)
87
-
-[Regras do @commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional).
88
-
89
-
Execute `npm run commit` para ter um painel interativo que permite seguir o padrão de commit de forma fácil.
90
-
91
-
> O commit é abortado caso esse padrão não seja seguido
0 commit comments