Skip to content

How to create pull request

Jump to bottom
Sandeep Sachan edited this page Aug 22, 2021 · 1 revision

Pull-Request checklist

Before you start

  1. Coding standards
  2. Code style guide
  3. Design
  4. Functionality
  5. Complexity
  6. Tests
  7. Naming
  8. Comments
  9. Consistency

Test

  • Follow generalized version of unit-test checklist
  • Do not comment/ignore test from the build pipeline

Documentation

  • Any changes applied to existing code should also update documentation

Before sending code to review

These guidelines should help you get through reviews faster and with higher-quality results

  • Smaller is better
  • How to handle reviwer comments
  • Work on pull request description
  • Do a self review (assume you are reviwer of code)
    • find out issues as reviewer
    • do not skip(pause) test
    • no test fail
    • Todo (Add more items here)
    • All code is formatted with Prettier
    • No build warnings
    • GitHub Actions CI pipeline (feedback/status)
      • Everything should be 🟩
      • No warnings/error

Pull Request

  • Think as reviewer(save time)
    • Add screenshot and comments
    • Share references of releveant internal or external links
  • Be explicit
    • Partial/Full implementation of task

For Code Reviewer

Clone this wiki locally