Thank you for investing your time in contributing to our project! Any contribution you make will be a stepping stone to helping others.
To get an overview of the project, read the README. All contributions will have to consider the following:
- Simple architecture and structure for beginners to understand.
- Docstring code documentation.
- FastAPI documention (https://fastapi.tiangolo.com/) guidelines.
- PEP-8 guidelines (https://peps.python.org/pep-0008/).
It is very simple to contribute, we accept all kinds of contributions. All PR's will be reviewed according to the Code Review Guidelines.
If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix.
After cloning the project and making the changes and/or fixes to your clone, create a PR(Pull Request).
- Don't forget to link your PR to the open issue you are solving.
- We may ask for changes to be amde before a PR can be merged.