Backend API in Django for the to-be comprehensive app for managing, finding and enjoying life at Indian Institute of Technology, Bombay!
Google's Python Style Guide is followed upto a certain extent in all modules.
Master branch of this repository is continuously deployed at staging.
Static OpenAPI specification can be found at the project page, at Apiary or at http://server/docs/
If you are modifying the API, make sure you regenerate docs by running python manage.py swagger
Pull requests are welcome, but make sure the following criteria are satisfied
- If you are (possibly) breaking an existing feature, state this explicitly in the PR description
- Commit messages should be in present tense, descriptive and relevant, closely following the GNOME Commit Message Guidelines. Adding a tag to the message is optional (for now). Commits should not have git tags unless they indicate a version change.
- Documentation should be updated when the API is modified
- All required status checks must pass. Barring exceptional cases, relevant tests should be added/updated whenever necessary.
- Barring exceptional cases, Codacy should not report any new issues
- Follow the general style of the project. Badly written or undocumented code might be rejected
- If you are proposing a new model or modifications to an existing one, create an issue first, explaining why it is useful
- Outdated, unsupported or closed-source libraries should not be used
- Be nice!