node-cpf-cnpj/CONTRIBUTING.md

Module Validate, Formate and Generate CPF and CNPJ Brazil

# Como contribuir com o projeto

- [Instalando o projeto](#instalando-o-projeto)
- [Reportando Issues](#reportando-issues)
- [Submetendo Pull Requests](#submetendo-pull-requests)

## Instalando o projeto

Para abrir um pull-request, primeiramente crie um fork do projeto para a sua conta, então clone o projeto em sua maquina:

`git clone git@github.com:seu-usuario/node-cpf-cnpj.git`

Em seguida baixe os modulos necessários com:

`npm install`

Agora pronto, você já pode começar a contribuir com o projeto!

## Reportando Issues

Você pode criar uma issue [aqui](https://github.com/rodrigooler/node-cpf-cnpj/issues), mas, lembre-se de ser claro e informar o máximo de detalhes possíveis.

## Submetendo Pull Requests
* Crie pull requests pequenos, para que a revisão seja feita mais facilmente
* Inclua detalhes do que está sendo feito na descrição
* Altera a documentação se for necessário
* Verifique se todos os testes estão passando localmente
* Não esqueça de verificar o build com as validações de teste coverage e build no travis-ci