Skip to content

Instantly share code, notes, and snippets.

@imtiazShakil

imtiazShakil/how_to_review_guide.md

Last active May 25, 2024 17:09
Show Gist options
  • Save imtiazShakil/4a0be6f8e13b87245c455c5b47ccfe29 to your computer and use it in GitHub Desktop.
Save imtiazShakil/4a0be6f8e13b87245c455c5b47ccfe29 to your computer and use it in GitHub Desktop.
Download ZIP
Review Guideline
Raw
how_to_review_guide.md

General: Basic review items that should be checked always

  • check all corner cases

Frontend: review items for spa app

  • build the project and view the changed pages to make sure everything is working perfectly
  • package.json updated?
    • check existing library synchronization
      • remove node_modules
      • run npm install
    • check node version
      • update node if possible
  • UI change
    • run old ui and compare side by side
    • check if css classes are well optimized (i.e. all unnecessary tags, classes are removed)
  • Code change
    • are all components well optimized?
      • check if there are unused fields declared
      • check if there are unnecessary fields present (field that is already covered by another field)
    • check if a component's @input or @output can be reduced by better optimization
  • do I write useful comments beside a field/css class? (plus point)
  • ensure code formatting (code format, import format)
  • check code comments
  • check for unused imports, check your ide. Find a good ide.

Backend: review items for backend

  • Did you patiently went through all the commit changes to see any unnecessary codes were pushed by mistake
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment