Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Arquivos de contribuição atualizados #111

Merged
merged 3 commits into from
Jun 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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
Expand Down
47 changes: 47 additions & 0 deletions CONTRIBUTING_EN.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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/
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
9 changes: 9 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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