1. Keep PR Focused on one purpose (not a whole feature or a whole project)
  2. Don’t mix refactoring with making new logic. (Do a refactor first and then make the logic)
  3. Clenup what is only related to your PR
  4. Avoid unneccessary renames of variables and functions
  5. Comment where needed (High level comment)
  6. Keep PRs small

For writing and packaging prs

  1. Make sure your PR has a good title
  2. Add a clear PR summary (what you added, changed, deleted)
  3. Highlight non-obvious logic, if there was any trickery or non-obvious logic
  4. Be clear what you haven’t done (Like adding a TODO)

  1. Add images (for UI changes)
  2. Add testing instructions for new or complex features
  3. Add pre-hook, automated jobs, launching block tests
  4. Retest manually
↑ Back to Best Practices