Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aliev committed Aug 10, 2021
1 parent 77b3934 commit cb4da4c
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
@@ -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 git@github.com: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%`

0 comments on commit cb4da4c

Please sign in to comment.