johnypark / Front-End-Checklist

πŸ—‚ The perfect Front-End Checklist for modern websites and meticulous developers

Home Page:http://frontendchecklist.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Front-End Checklist

CC0 Contributors

The Front-End Checklist is an exhaustive list of all elements you need to have / to test before launching your site / page HTML to production.

It is based on Front-End developers' years of experience, with the addition from some other open-source checklists.

Table of Contents

  1. How to use
  2. Head
  3. HTML
  4. Webfonts
  5. CSS
  6. Images
  7. JavaScript
  8. Performance
  9. Accessibility
  10. SEO

How to use?

All items in the Front-End Checklist are required for the majority of the projects, but some elements can be omitted or not essential (in case of an administration web app, you may not need RSS feed for example). We choose to use 3 levels of flexibility:

  • Low means that the item is recommended but can be omitted in some particular situations.
  • Medium means that the item is highly recommended and can eventually be omitted in some really particular cases. Some elements, if omitted, can have bad repercutions in terms of performance or SEO.
  • High means that the item can't be omitted by any reason. You may cause a disfunction in your page or have accessibility or SEO issues. The testing priority needs to be on these elements first.

Some resources possess an emoticon to help you understand which type of content / help you may find on the checklist:

  • πŸ“–: documentation or article
  • πŸ› : online tool / testing tool
  • πŸ“Ή: media or video content

Head

Notes: You can find a list of everything that could be found in the <head> of an HTML document.

Meta tag

  • Doctype: High The Doctype is HTML5 and is in the top of all your HTML pages.
<!-- Doctype HTML5 -->
<!DOCTYPE html>

πŸ“– Determining the character encoding - HTML5 W3C

The next 3 meta tags (Charset, X-UA Compatible and Viewport) need to come first in the head.

  • Charset: High The charset declared (UTF-8) is declared correctly.
<!-- Set character encoding for the document -->
<meta charset="utf-8">
  • X-UA-Compatible: Medium The X-UA-Compatible meta tag is present.
<!-- Set character encoding for the document -->
<meta http-equiv="x-ua-compatible" content="ie=edge">

πŸ“– Specifying legacy document modes (Internet Explorer)

  • Viewport: High The viewport is declared correctly
<!-- Viewport for responsive web design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
  • Title: High A title is used on all pages (SEO: No more than 65 characters, website title included)
<!-- Document Title -->
<title>Page Title less than 65 characters</title>

πŸ“– Title - HTML | MDN

  • Description: High A meta description is provided, it is unique and doesn't possess more than 150 characters.
<!-- Meta Description -->
<meta name="description" content="Description of the page less than 150 characters">
  • Favicons: Medium Each favicon has been created and displays correctly. If you have only a favicon.ico, put it at the root of your site. Normally you won't need to use any markup. However, it's still good practice to link to it using the example below. Today, PNG format is recommended over .ico format (dimensions: 32x32px)
<!-- Standard favicon -->
<link rel="icon" type="image/x-icon" href="https://example.com/favicon.ico" />
<!-- Recommended favicon format -->
<link rel="icon" type="image/png" href="https://example.com/favicon.png" />
  • Apple Touch Icon: Low Apple touch favicon apple-mobile-web-app-capable are present. (Create your Apple Icon file with at least 200x200px dimension to support all dimensions that you may need)
<!-- Apple Touch Icon -->
<link rel="apple-touch-icon" href="/custom-icon.png">
  • Canonical: Medium Use rel="canonical" to avoid duplicate content.
<!-- Helps prevent duplicate content issues -->
<link rel="canonical" href="http://example.com/2017/09/a-new-article-to-red.html">

HTML tags

  • Language tag: High The language tag of your website is specified and related to the language of the current page.
<body lang="en">
  • Direction tag: Medium The direction of lecture is specified on the body tag (It can be used on another HTML tag).
<body dir="rtl">

πŸ“– dir - HTML | MDN

  • Alternate language: Low The language tag of your website is specified and related to the language of the current page.
<link rel="alternate" href="https://es.example.com/" hreflang="es">
  • Conditional comments: Low Conditional comments are present for IE if needed.

πŸ“– About conditional comments (Internet Explorer) - MSDN - Microsoft

  • RSS feed: Low If your project is a blog or has articles, an RSS link was provided.

  • CSS Critical: Medium The CSS critical (or "above the fold") collects all the CSS used to render the visible portion of the page. It is embedded before your principal CSS call and between <style></style> in a single line (minified).

πŸ›  Critical by Addy Osmany on Github

  • CSS order: High All CSS files are loaded before any JavaScript files in the <head>. (Except the case, where sometimes JS files are loaded asynchronously on top of your page).

Social meta

Facebook OG and Twitter Cards are, for any website, highly recommended. The other social media tags can be considered if you target a particular presence on those and want to ensure the display.

  • Facebook Open Graph: Low All Facebook Open Graph (OG) are tested and no one is missing or with a false information. Images need to be at least 600 x 315 pixels, 1200 x 630 pixels recommended.
<meta property="og:type" content="website">
<meta property="og:url" content="https://example.com/page.html">
<meta property="og:title" content="Content Title">
<meta property="og:image" content="https://example.com/image.jpg">
<meta property="og:description" content="Description Here">
<meta property="og:site_name" content="Site Name">
<meta property="og:locale" content="en_US">
  • Twitter Card: Low
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@site_account">
<meta name="twitter:creator" content="@individual_account">
<meta name="twitter:url" content="https://example.com/page.html">
<meta name="twitter:title" content="Content Title">
<meta name="twitter:description" content="Content description less than 200 characters">
<meta name="twitter:image" content="https://example.com/image.jpg">

⬆ back to top


HTML

Best practices

  • HTML5 Semantic Elements: High HTML5 Semantic Elements are used appropriately (header, section, footer, main...)

πŸ“– HTML Reference

  • Structured Data: High Pages using structured data are tested and are without errors.

πŸ“– Introduction to Structured Data | Search | Google Developers πŸ›  Test your page with the Structured Data Testing Tool

  • Error pages: High Error 404 page and 5xx exist. Remember that the 5xx error page needs to have his CSS integrated (no external call on the current server).
  • Noopener: Medium In case you are using target="_blank" on your links, rel="noreferrer noopener" is present on the <img>.
  • Clean up comments: Low Unnecessary code needs to be removed before sending the page to production.

HTML testing

  • W3C compliant:: High All pages need to be tested with the W3C validator to identify possible issues in the HTML code.

πŸ›  W3C validator

  • HTML Lint: High I use tools to help me analyse any issues I could have on my HTML code.

πŸ›  Dirty markup

  • Desktop Browsers: High All pages were tested on all current desktop browsers (Safari, Firefox, Chrome, Internet Explorer, EDGE...).

  • Desktop Mobile: High All pages were tested on all current mobile browser (Native browser, Chrome, Safari...).

  • Link checker: High There are no broken links in my page, verify that you don't have any 404 error.

  • Adblockers test: Medium Your website shows your content correctly with adblockers enabled (You can provide a message encouraging people to disable their adblocker)
  • Pixel perfect: High Pages are close to pixel perfect. Depending on the quality of the creatives, you may not be 100% accurate, but your page needs to be close to your template.

Pixel Perfect - Chrome Extension

⬆ back to top


Webfonts

  • Webfront format: High WOFF, WOFF2 and TTF are supported by all modern browsers.
  • Webfont size: High Webfont sizes don't exceed 2 MO (all variants included)

⬆ back to top


CSS

Notes: Take a look on CSS guidelines and Sass Guidelines followed by most Front-End developers. If you have a doubt on CSS properties, you can visit CSS Reference.

  • Responsve Web Design: High The website is using responsive web design.
  • CSS Print: Medium A print stylesheet is provided and is correct on each page.
  • Preprocessors: Medium Your page is using a CSS preprocessor (Sass is preferred).
  • Unique ID: High If IDs are used, they are unique to a page
  • Reset CSS: High A CSS reset (reset, normalize or reboot) is used and up to date. (If you are using a CSS Framework like Twitter Bootstrap or Foundation, a Normalize is already included into it.)
  • JS prefix: Low All classes (or id- used in JavaScript files) begin with js- and are not styled into the CSS files.
<div id="js-slider" class="my-slider">
<!-- Or -->
<div id="id-used-by-cms" class="js-slider my-slider">
  • CSS embed or line: High Avoid at all cost the use of CSS embed or inline: only used for valid reasons (ex: background-image for slider, CSS critical).
  • Vendor prefixes: High CSS vendor prefixes are used and are generated accordingly with your browser support compatibility.

πŸ›  Autoprefixer CSS online

Performance

  • Concatenation: High CSS files are concatenated in a single file (Not for HTTP2)
  • Minification: High All CSS files are minified. (Not for HTTP2)
  • Non-blocking: Medium CSS files need to be non-blocking to prevent the DOM from taking time to load.
  • Unused CSS: Low Remove unused CSS

CSS testing

  • Stylelint: High All CSS or SCSS files are without any errors.
  • Responsive web design: High All pages were tested at the following breakpoints: 320px, 768px, 1024px (can be fmore / different according to your analytics).

  • CSS Validator:: Medium The CSS was tested and pertinent errors were corrected.

πŸ›  CSS Validator

  • Debug CSS: Low Pages were tested with DebugCSS

πŸ›  Debug CSS (you can use the bookmarklet)

  • Reading direction: High All pages need to be tested for LTR and RTL languages if they need to be supported.

⬆ back to top


Images

Notes: For a complete understanding of image optimization, check the free ebook Essential Image Optimization from Addy Osmani.

Best practices

  • Optimization: High All images are optimized to be rendered in the browser. WebP format could be used for critical pages (like Homepage).
  • Retina: Low You provide layout images x2 or 3x, support retina display.
  • Sprite: Medium Small images are in a sprite file (in case of icons, they can be in an SVG sprite image).
  • Width and Height: High All <img> have height and width set (Don't specify px or %).

Note: Lots of developers assume that width and height are not compatible with responsive web design. It's absolutely not the case.

  • Alternative text: High All <img> have an alternative text which describe the image visually.
  • Lazy loading: Medium Images are lazyloaded (A noscript fallback is always provided).

⬆ back to top


JavaScript

Best practices

  • JavaScript Inline: High You don't have any JavaScript code inline (mixed with your HTML code).
  • Concatenation: High JavaScript files are concatenated.
  • Minification:: High JavaScript files are minified (you can add the .min suffix).

Minify Resources (HTML, CSS, and JavaScript)

  • Non-blocking: Medium JavaScript files are loaded asynchronously using async or deferred using defer attribute.

πŸ“– Remove Render-Blocking JavaScript

  • Modernizr: Low If you need to target some specific features you can use a custom Modernizr to add classes in your <html> tag.

πŸ›  Customize your Modernizr

JavaScript testing

  • ESLint: High No errors are flagged by ESLint (based on your configuration or standards rules)

⬆ back to top


Performance

Best practices

  • Weight page: High The weight of each page is between 0ko and 500ko
  • Minified: Medium Your HTML is minified

πŸ›  W3C Validator

  • Lazy loading: Medium Images, scripts and css need to be lazy loaded to improve the response time of the current page (See details in their respective sections).

Performance testing

  • Google PageSpeed: High All your pages were tested (not only the homepage) and have min 90/100.

⬆ back to top


Accessibility

Notes: You can watch the playlist A11ycasts with Rob Dodson πŸ“Ή

Best practices

  • Progressive enhancement: Medium Major functionality like main navigation and search should work without JavaScript enabled.

πŸ“– Enable / Disable JavaScript in Chrome Developer Tools

  • Color contrast: Medium Color contrast should at least pass WCAG AA (AAA for mobile)

πŸ›  Contrast ratio

Headings

  • H1: High All pages have an H1 which is not the title of the website.
  • Headings: High Headings should be used properly in the right order (H1 to H6)

πŸ“Ή Why headings and landmarks are so important -- A11ycasts #18

Landmarks

  • Role banner: High <header> has role="banner"
  • Role navigation: High <nav> has role="navigation"
  • Role main: High <main> has role="main"

πŸ“– Using ARIA landmarks to identify regions of a page

Semantics

  • Specific HTML5 input types are used: This is especially important for mobile devices that show customized keypads and widgets for different types.

πŸ“– Mobile Input Types

Form

  • Label: High A label is associated with each input form element. In case, a label can't be display, use aria-label instead.

πŸ“– Using the aria-label attribute - MDN

Accessibility testing

  • Accessibility standards testing: High Use the WAVE tool to test if your page respects the accessibility standards.

πŸ›  Wave testing

  • Keyboard navigation: High Test your website using only your keyboard in a previsible order. All interactive elements are reachable and usable.
  • Screen-reader: Medium All pages were tested in a screen-reader (VoiceOver, ChromeVox, NVDA or Lynx).
  • Focus style: High If the focus is disabled, it is replaced by visible state in CSS.

πŸ“Ή Managing Focus - A11ycasts #22

⬆ back to top


SEO

  • Google Analytics: High Google Analytics is installed and correctly configured.
  • Headings logic: Medium Heading text helps to understand the content in the current page.
  • sitemap.xml: High A sitemap.xml exists and was submit in Google Search Console (ex:Google Webmaster Tools)
  • robot.txt: High The robot.txt is not blocking webpages Link your website to the Google webmaster tools
  • Sitemap HTML: Medium An HTML sitemap is provided and is accessible via a link in the footer of your website.

⬆ back to top


Contributing

Open an issue or a pull request to suggest changes or additions.

Guide

The Front-End Checklist repository consists of two branches:

1. master

This branch consists of the README.md file that is automatically reflected on the Front-End Checklist website.

2. develop

This branch will be used to make some significant changes to the structure, content if needed. It is preferable to use the master branch to fix small errors or add a new item.

Contributors

Check out all the super awesome contributors.

Authors

David Dias, Geoffrey Signorato, Sandeep Ramgolam and CΓ©dric Poilly.

License

CC0

⬆ back to top

About

πŸ—‚ The perfect Front-End Checklist for modern websites and meticulous developers

http://frontendchecklist.com

License:MIT License