README.md

Hi there 👋

We are here to do hard things.

Contributing Guidelines

• Always use a .env file to store your environment variables. Use the .env.example file as a template.
• Always add / update the README.md to explain how to setup the project locally.
• Use 4 spaces for indentation
• Use snake_case for variables and methods
• Use CamelCase for classes and modules
• Use SCREAMING_SNAKE_CASE for constants
• Always comment your code
• Use flake8 to check your code
• Add tests for your code
• Use pytest to run the tests
• Never commit your changes to the main branch
• Always create a new branch for your changes
• Always create a pull request for your changes and wait for the review
• Always add a description and image screenshot of the working swagger api call to your pull request
• Always add a description to your commits