globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

CONTRIBUTING.md

Browse source
This commit is contained in:
Éloi Rivard 2020-11-05 17:51:59 +01:00
parent 664669d3d0
commit dbf1cb14b8
2 changed files with 22 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,20 @@
# Contribute
Contributions are welcome!
## Unit tests
To run the tests, you just need to run `tox`. Everything must be green before patches get merged.
## Style
We use `black` to format our code. Please apply `black` on your patches before submiting them.
## Development environment
To try a development environment, you can run the docker image and then open https://127.0.0.1:5000
You can then connect with user *admin* and password *admin* to access an admin account, or user *user* and password *user* for a regular one.
```bash
cp canaille/conf/config.sample.toml canaille/conf/config.toml
cp canaille/conf/oauth-authorization-server.sample.json canaille/conf/oauth-authorization-server.json
cp canaille/conf/openid-configuration.sample.json canaille/conf/openid-configuration.json
docker-compose up
```

15
README.md
View file

@ -65,17 +65,6 @@ expired tokens and authorization codes with:
env CONFIG=/path/to/config.toml FASK_APP=canaille flask clean
```
## Contribute
# Contribute
Contributions are welcome!
To run the tests, you just need to run `tox`.
To try a development environment, you can run the docker image and then open https://127.0.0.1:5000
You can then connect with user *admin* and password *admin* to access an admin account, or user *user* and password *user* for a regular one.
```bash
cp canaille/conf/config.sample.toml canaille/conf/config.toml
cp canaille/conf/oauth-authorization-server.sample.json canaille/conf/oauth-authorization-server.json
cp canaille/conf/openid-configuration.sample.json canaille/conf/openid-configuration.json
docker-compose up
```
Want to contribute? Take a look on [CONTRIBUTING.md](CONTRIBUTING.md).