This pull request is to open a discussion on what checks and guidelines can we introduce to ensure the pull requests are easy to go through and merge.
The discussion on this pull request will finally be incorporated into the Development.
Current Ideas:
A checklist for the developer to go through before marking the PR ready for review. This checklist can help accelerate the process of review for the maintainers.
Checklist:
Make sure you have tested your changes locally.
Make sure you have added the necessary test cases for your changes.
Make sure you have added the necessary documentation for your changes.
Added one-liner crisp comments describing the logic flow.
Added Docstrings to any new functions written.
Updated the README.md file with the necessary information.
Updated the Requirements.txt for any new dependencies added. (Auto-generated from Poetry using poetry export command)
Make sure you have added the necessary changes to the .env.example file.
A triaging system that divides the pull request into following categories - templates, views, models, admin-portal
What:
This pull request is to open a discussion on what checks and guidelines can we introduce to ensure the pull requests are easy to go through and merge.
The discussion on this pull request will finally be incorporated into the Development.
Current Ideas:
templates,views,models,admin-portal