Skip to content

Code Review Checklist

natafaye edited this page Feb 11, 2022 · 2 revisions

Before you submit a pull request, make sure that you've reviewed your own code.

  • Did you complete all the requirements in the task? Check that your code fulfills everything in the task description.

  • Does your code follow the style guide? Check for any ESLint warnings and that you are following good naming practices. You can find the Airbnb Style Guide here: https:/airbnb/javascript

  • Did you comment your code? Your code should have documentation comments for every component and prop type, and comments every ~2-10 lines explaining what each chunk is doing.

  • Is your code generating any errors or warnings in the console? Check that none show up when you first load the app nor as you use it.

  • Does it look good at all viewport sizes? Use the developer tools to view it at various sizes and make sure that everything is readable and visually pleasant.

  • Have you tested your code? Don't just test that it works when a user uses it correctly. What if a user tries to break it? Can they?

Clone this wiki locally