root/pssecret-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added Contributing section to README

Browse source
This commit is contained in:
Ivan Golikov 2022-06-12 15:44:27 +03:00
parent c28c307670
commit faa6bd8beb
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -7,3 +7,18 @@ This service tries to be as anonymous as possible. The only personal information
on a server will be IP address of the client that made request to the server. on a server will be IP address of the client that made request to the server.
Service is built with Python, FastAPI and is using Redis for data storage. Service is built with Python, FastAPI and is using Redis for data storage.
## Contributing
Codestyle is enforced with Black, and additional checks are done with the help of pre-commit-hooks,
Flake8 and isort. Prior to making any commits, install `pre-commit` tool and install hooks:
```
# Alternatively, you could use 'pip install ".[development]"'
$ pip install pre-commit==2.19.0
$ pre-commit install
```
This way you will always be sure that new code follows project guidelines.
This project is using trunk-based branching strategy with the `main` as trunk branch.