PR Review

Review the current Pull Request that has been checked out locally.

Instructions

1. •

   ** Prerequisite **

   • •Run git fetch origin master to ensure we have the latest main branch
2. •

   Get the PR changes

   • •Run git diff $(git merge-base HEAD origin/master)..HEAD to see all changes
   • •If master doesn't exist, try origin/main
   • •Run git log --oneline $(git merge-base HEAD origin/main)..HEAD to see commit messages
3. •

   Understand the context

   • •Examine the changed files to understand the PR's purpose
   • •Look for any related documentation or comments
4. •

   Provide a structured code review

   Summary

   • •Brief overview of what this PR accomplishes
   • •Number of files changed and scope

   Code Quality

   • •Code organization and structure
   • •Readability and maintainability
   • •Adherence to best practices
   • •Error handling

   Potential Issues

   • •Bugs or logic errors
   • •Unhandled edge cases
   • •Performance concerns
   • •Security vulnerabilities
   • •Concurrency issues

   Testing

   • •Adequacy of tests
   • •Whether existing tests are updated
   • •Suggested additional test cases

   Documentation

   • •Clarity of code comments
   • •Updated documentation (README, API docs)
   • •Explanation of complex logic

   Suggestions

   • •Specific improvements with code examples
   • •Refactoring opportunities
   • •Alternative approaches
5. •

   Output Format

   • •Use markdown formatting
   • •Make it ready to paste into a Bitbucket PR comment
   • •Be constructive and educational
   • •Praise good practices while noting issues