Merge Request Checklist

Use this checklist to ensure your code is ready for review and merging into the main branch.

🔍 Code Quality

  • Code follows BodhiTree coding guidelines and best practices

  • Linting and formatting applied (black, prettier, etc.)

  • No commented-out code or debugging statements (e.g., console.log, print)

  • Code is modular, readable, and reusable where applicable

🧪 Testing

  • All unit tests are written and passing

  • Test cases follow the defined TDD format

  • Manual testing completed for all critical paths

  • Edge cases and invalid inputs are handled

  • No flaky tests or hardcoded dependencies

📄 Documentation

  • Feature is listed and linked in the Developer Documentation index

  • Code-level comments and docstrings are clear and useful

  • README or feature documentation updated (if applicable)

🔐 Security & Performance

  • Inputs validated to prevent injection or unauthorized access

  • No sensitive data (passwords, tokens) in code

  • Performance impact considered (large loops, DB queries, etc.)

🚀 Deployment Readiness

  • Feature flagged or toggle-enabled (if experimental)

  • No breaking changes introduced

  • DB migrations (if any) are backward compatible

  • Feature tested on staging environment

📝 Merge Request Metadata

  • Descriptive title (e.g., feat: add interactive quiz popups)

  • MR description includes:

    • What & why

    • Screenshots (if UI-related)

    • Linked task or issue

  • Reviewer(s) assigned

  • Label(s) added (e.g., backend, frontend, urgent)

🧑‍⚖️ Reviewer Checks (For Reviewers Only)

  • Code follows overall system architecture and boundaries

  • Design decisions align with platform goals

  • Comments are constructive and actionable

  • Requested changes (if any) have been addressed