Skip to content

Instantly share code, notes, and snippets.

@zstix
Created July 8, 2021 20:52
Show Gist options
  • Save zstix/8377409a90e9c4cb9efa1d9f75b972b4 to your computer and use it in GitHub Desktop.
Save zstix/8377409a90e9c4cb9efa1d9f75b972b4 to your computer and use it in GitHub Desktop.
A checklist of things to check while reviewing a front-end pull request

1. Continuous Integration

  1. Have the required tests passed?
  2. Has the build completed successfully?
  3. Does the submitted code meet linting requirements?
  4. Have all the other required checks passed?

2. Code Style

  1. Are variables and function names consistent with the code base?
  2. Are variables and function names clear and accurate?
  3. Are the files located in a reasonable location?
  4. Are all the files related to the purpose of PR?
  5. Are the included libraries required?
  6. Are comments included when the code may not be clear?

3. CSS

  1. Does it render well in blink (Chrome)?
  2. Does it render well in gecko (Firefox)?
  3. Does it render well in webkit (Safari)?
  4. Does it render well on a mobile breakpoint?
  5. Does it render well on a mobile breakpoint?
  6. Does it render well on an android device?
  7. Does it render well on an iOS device?
  8. Do all the style rules used have good browser support?

4. Javascript

  1. Is the browser console clear of errors?
  2. Are all the network requests successful?
  3. Does that page load in a timely manner?
  4. Do all the APIs used have good browser support?
  5. Are all the network requests debounced as needed?
  6. Are there no duplicate network requests?
  7. Are there no duplicate function calls / unnecessary render calls?

5. Security

  1. Are there no secrets / sensitive information checked in?
  2. Are all the references to environmental variables set correctly?
  3. Are all the inputs safe from code injection?

6. Accessibility

  1. Are semantic tags used (where applicable)?
  2. Does the page structure make sense for screen readers (headings, sections, etc)?
  3. Are all the meaningful page elements represented in the HTML (as supposed to images)?
  4. Do all images have alt tags?
  5. Are tab-indexes included?
  6. Does the text have an appropriate amount of contrast?

7. Github

  1. Is the code branched off the correct base branch?
  2. Does the PR have a descriptive title?
  3. Does the PR include an informative description?
  4. Is the issue linked correctly?
  5. Are the applicable labels added?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment