-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
All contributions are welcome – especially: | ||
|
||
- documentation, | ||
- bug reports and issues, | ||
- code contributions. | ||
|
||
### Code | ||
|
||
If you'd like to actively develop or help maintain this project then there are existing tests against which you can test the library with. Typically, this looks like | ||
|
||
- `git clone [email protected]:aliev/aioauth.git` | ||
- `cd aioauth` | ||
- `python -mvenv env` | ||
- `source env/bin/activate` | ||
- `make dev-install` | ||
|
||
`make dev-install` will also install all the required packages that will allow you to adhere to the code styling guide of `aioauth`. | ||
|
||
Basically we use the `black` and `flake8` packages for code formatting, `pre-commit` package will check the code formatting before your first commit is made. | ||
|
||
To automatically correct the formatting you can run the command inside the repository root: | ||
|
||
``` | ||
pre-commit run --all-files | ||
``` | ||
|
||
Running tests: | ||
|
||
``` | ||
make test | ||
``` | ||
|
||
the output result will also show the current coverage, please make sure the coverage is not below `99%` |