diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8d616a..7b99b39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,42 +1,42 @@ # Contributing -Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts! +Obrigada por disponibilizar seu tempo para contribuir! 🙇‍♀️🙇‍♂️ Toda ajuda é bem-vinda! -## Installation -### Requirements +## Instalação +### Requisitos - [Python 3.7+][python] - [Poetry][poetry] -Fork or clone the repository and enter into the project's folder: +'Fork' ou clone o repositório e entre na pasta do projeto: ```shell $ git clone git@github.com:brazilian-utils/brutils-python.git $ cd brutils-python ``` -Create a [virtualenv][virtualenv] for brutils and activate it: +Crie uma [virtualenv][virtualenv] para brutils e ative: ```shell $ make shell ``` -**Note: You need to run `make shell` every time you open a new terminal window/tab.** +**Nota: Você vai precisar rodar `make shell` todas as vezes que abrir um novo terminal.** -Install the dependencies: +Instale as dependências: ```shell $ make install ``` -## Using locally +## Usando localmente ```shell $ make run-python ``` -Now, you can use it [in the same way described in the README.md file](/README.md#usage) +Agora, você pode usá-lo [da mesma forma descrita no arquivo README.md](/README.md#usage) -## Tests +## Testes ```shell $ make test diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md new file mode 100644 index 0000000..8ba4a3b --- /dev/null +++ b/CONTRIBUTING_EN.md @@ -0,0 +1,47 @@ +# Contributing + +Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts! + +## Installation +### Requirements +- [Python 3.7+][python] +- [Poetry][poetry] + +Fork or clone the repository and enter into the project's folder: + +```shell +$ git clone git@github.com:brazilian-utils/brutils-python.git +$ cd brutils-python +``` + +Create a [virtualenv][virtualenv] for brutils and activate it: + +```shell +$ make shell +``` + +**Note: You need to run `make shell` every time you open a new terminal window/tab.** + +Install the dependencies: + +```shell +$ make install +``` + +## Using locally + +```shell +$ make run-python +``` + +Now, you can use it [in the same way described in the README.md file](/README_EN.md#usage) + +## Tests + +```shell +$ make test +``` + +[poetry]: https://python-poetry.org/docs/#installation +[python]: https://www.python.org/downloads/ +[virtualenv]: https://virtualenv.pypa.io/en/latest/ diff --git a/README.md b/README.md index 19246e0..1effea7 100644 --- a/README.md +++ b/README.md @@ -127,3 +127,12 @@ Gera um CNPJ válido aleatório. >>> generate_cnpj() '34665388000161' ``` + +## Contributing + +Sua colaboração é sempre bem-vinda! Preparamos o [arquivo contributing][contributing] pra te ajudar nos primeiros passos. Toda ajuda conta! Sinta-se livre para criar novas [GitHub issues][github-issues] e interagir aqui. + +Vamos construir juntos! 🚀🚀 + +[github-issues]: https://github.com/brazilian-utils/brutils-python/issues +[contributing]: CONTRIBUTING.md diff --git a/README_EN.md b/README_EN.md index c607124..3c72306 100644 --- a/README_EN.md +++ b/README_EN.md @@ -132,3 +132,12 @@ Generate a valid random CNPJ. >>> generate_cnpj() '34665388000161' ``` + +## Contributing + +Collaboration is super welcome! We prepared the [contributing file][contributing] to help you in the first steps. Every little bit of help counts! Feel free to create new [GitHub issues][github-issues] and interact here. + +Let's build it together 🚀🚀 + +[github-issues]: https://github.com/brazilian-utils/brutils-python/issues +[contributing]: CONTRIBUTING_EN.md