Contributions are welcome and there are many ways to participate to the project.
Before starting to contribute please install the Git hook scripts:
$ git clone https://github.com/scandale-project/scandale
$ cd scandale/
$ poetry install
$ pre-commit installYou can contribute by:
- reporting bugs;
- suggesting enhancements or new features;
- improving the documentation.
Feel free to fork the code, play with it, make some patches and send us pull requests.
There is one main branch: what we consider as stable with frequent updates as hot-fixes.
Features are developed in separated branches and then regularly merged into the master stable branch.
If your contribution require some documentation changes, a pull-request in order to update the documentation is strongly recommended.
Please, do not open directly a GitHub issue if you think you have found a security vulnerability. See our security policy page.
FastAPI is used for the backend API. Please use black for the syntax of your Python code.
Please provide documentation when changing, removing, or adding features. Documentation resides in the project's docs folder.
$ poetry install
$ make docIt will generate the documentation.