Skip to content

Commit 65cdbbd

Browse files
pedrrofilipedeschamps
authored andcommitted
chore(readme): add contributor guide by @pedrro
* Add contributor guide * Add info about test coverage and build status on CONTRIBUTING.md
1 parent 580360e commit 65cdbbd

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Como contribuir com o projeto
2+
3+
- [Instalando o projeto](#instalando-o-projeto)
4+
- [Reportando Issues](#reportando-issues)
5+
- [Submetendo Pull Requests](#submetendo-pull-requests)
6+
7+
## Instalando o projeto
8+
9+
Para abrir um pull-request, primeiramente crie um fork do projeto para a sua conta, então clone o projeto em sua maquina:
10+
11+
`git clone [email protected]:seu-usuario/cep-promise.git`
12+
13+
Em seguida baixe os modulos necessários com:
14+
15+
`npm install`
16+
17+
Agora pronto, você já pode começar a contribuir com o projeto!
18+
19+
## Reportando Issues
20+
21+
Você pode criar uma issue [aqui](https://github.com/filipedeschamps/cep-promise/issues), mas, lembre-se de ser claro e informar o máximo de detalhes possíveis.
22+
23+
## Submetendo Pull Requests
24+
* Crie pull requests pequenos, para que a revisão seja feita mais facilmente
25+
* Inclua detalhes do que está sendo feito na descrição
26+
* Altera a documentação se for necessário
27+
* Verifique se todos os testes estão passando localmente
28+
* Não esqueça de verificar o build com as validações de teste coverage e build no travis-ci

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,10 @@ cep('123456789123456789')
129129
// }
130130
```
131131

132+
## Como contribuir
133+
134+
Leia nosso guia de contribuição [aqui](CONTRIBUTING.md)
135+
132136
## Contribuidores
133137

134138
| [<img src="https://avatars1.githubusercontent.com/u/8251208?v=3&s=115"><br><sub>@lucianopf</sub>](https://github.com/lucianopf) | [<img src="https://avatars1.githubusercontent.com/u/7863230?v=3&s=115"><br><sub>@MarcoWorms</sub>](https://github.com/MarcoWorms) | [<img src="https://avatars1.githubusercontent.com/u/551228?v=3&s=115"><br><sub>@caio-ribeiro-pereira</sub>](https://github.com/caio-ribeiro-pereira) | [<img src="https://avatars1.githubusercontent.com/u/1225447?v=3&s=115"><br><sub>@chrisbenseler</sub>](https://github.com/chrisbenseler) | [<img src="https://avatars0.githubusercontent.com/u/3428149?v=3&s=115"><br><sub>@luanmuniz</sub>](https://github.com/luanmuniz) | [<img src="https://avatars3.githubusercontent.com/u/3094496?v=3&s=115"><br><sub>@AlbertoTrindade</sub>](https://github.com/AlbertoTrindade) |

0 commit comments

Comments
 (0)