Skip to content

Instantly share code, notes, and snippets.

@danielantelo
Last active July 24, 2016 17:24
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save danielantelo/46dedfa445330e90cc03 to your computer and use it in GitHub Desktop.
Save danielantelo/46dedfa445330e90cc03 to your computer and use it in GitHub Desktop.
Code reviews

Submitting a PR

For every pull request for user facing changes, we should include the following in the PR description:

You should also be checking and optimizing any code being submitted as follows:

  • Optimise your changes for speed. Use the YSlow plugin and optimise before submitting a PR
  • Clean up your markup by using the HTML5 markup validator https://html5.validator.nu
  • Minimise JS and CSS errors by checking the console for errors and warnings
  • Meet WCAG 2.0 AA standards using http://wave.webaim.org or one of their browser extensions

Reviewing a PR

When reviewing a PR keep you should:

  • Check for missing tests!
  • Check for missed opportunities to add micro data from schema.org
  • Point out if images or page outline or schema summary is missing from the PR description
  • Check for code that can be abstracted into a reusable component
  • Identify any possible performance issues
  • Identify poor page structure or semantical content
  • Identify any possible accessibility issues
  • Ensure all HTML and CSS is mobile first responsive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment