-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Arquivos de contribuição atualizados (#111)
* adicionando contributing ao readme * Atualizar arquivos de Contribuição * Update README.md Pequena alteração sugerida no texto, tirando o espaço a mais que passou despercebido. Co-authored-by: Camila Maia <cmaiacd@gmail.com> --------- Co-authored-by: Camila Maia <cmaiacd@gmail.com>
- Loading branch information
1 parent
5ad023f
commit a9b80c3
Showing
4 changed files
with
75 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters