Skip to main content

Checklist for software pull requests.

Pull Request Template

  • Look for possible automated tests, and if they are available, review them
  • Look for potential bugs
  • Check if all errors are handled gracefully
  • Check if code is implemented efficiently, e.g.:
    • Does the code contain duplicates?
    • Are patterns and design principles properly used?
  • Check if the code introduces technical debt
  • Check if the code does not cause side effects
  • Check code readability
    • Is the code easy to understand for later maintenance if the need arises?
    • Do method and variable names express what they are used for?
  • Check if code is properly commented - difficult to understand parts or hacks should always be commented on to help other people understand the reason for the implementation
  • Check if all comments are addressed before merging to the main/master branch
  • Check Secure Coding Guideline in PCP R&D Processes
Owner: Software Development Team