Skip to content

Commit f0700a4

Browse files
docs(contributing): reordenar seção e explicitar possibilidade de apoio
1 parent 6c569fb commit f0700a4

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

.github/CONTRIBUTING.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
**Esse documento apresenta todas as informações necessárias para que possa colaborar com o projeto de forma independente.**
1515

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+
1618
Você pode contribuir de várias maneiras, sendo as mais conhecidas as seguintes:
1719

1820
- Localizando e relatando bugs
@@ -31,12 +33,38 @@ Você pode contribuir de várias maneiras, sendo as mais conhecidas as seguintes
3133
4. Faça o seu commit usando `npm run commit`;
3234
5. Envie um [pull request](https://help.github.com/articles/about-pull-requests/);
3335
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.
3536

3637
### Legenda
3738
#### 💥 > Validação realizada na integração contínua e entrega contínua
3839
#### 💻 > Validação realizada no pré-commit
3940

41+
## 💥💻 Lint
42+
43+
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
44+
45+
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
52+
53+
## 💥💻 Commit
54+
55+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
56+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
57+
58+
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+
4068
## 💥 Testes de API
4169

4270
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
6391

6492
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.
6593

66-
## 💥💻 Lint
67-
68-
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
69-
70-
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
77-
78-
## 💥💻 Commit
79-
80-
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
81-
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
82-
83-
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
94+
---
9295

9396
## Documentação (api-doc)
9497

0 commit comments

Comments
 (0)