1 Star 0 Fork 0

一路南漂 / Front-End-Checklist

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
CC0-1.0

Front-End Checklist

Contributors CC0

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. Security
  9. Performance
  10. Accessibility
  11. 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 are not essential (in the 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 repercussions in terms of performance or SEO.
  • High means that the item can't be omitted by any reason. You may cause a dysfunction 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 at 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.
<!-- Instruct Internet Explorer to use its latest rendering engine -->
<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">

📖 Configuring Web Applications

  • 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.
<html lang="en">
  • Direction tag: Medium The direction of lecture is specified on the body tag (It can be used on another HTML tag).
<html 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

  • 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 external links with target="_blank", your link should have a rel="noopener" attribute to prevent tab nabbing. If you need to support older versions of Firefox, use rel="noopener noreferrer".

📖 About rel=noopener

  • 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 analyze 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...).

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

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

🛠 W3C Link Checker

  • 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

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

⬆ back to top


CSS

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

  • Responsive 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 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 HTTP/2)
  • Minification: High All CSS files are minified.
  • 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 more / different according to your analytics).

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

🛠 CSS Validator

  • 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 the 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)

  • JavaScript security:

Guidelines for Developing Secure Applications Utilizing 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


Security

Scan and check your web site

Best practices

  • HTTPS: Medium HTTPS is used on every pages and for all external content (plugins, images...).
  • HTTP Strict Transport Security (HSTS): Medium The HTTP header is set to 'Strict-Transport-Security'.
  • Cross Site Request Forgery (CSRF): High Your are ensure that requests made to your server-side are legitimate and originate from your website / app to prevent CSRF attacks.

📖 Cross-Site Request Forgery (CSRF) Prevention Cheat Sheet - OWASP

  • Cross Site Scripting (XSS): High Your page or website is free from XSS possible issues.
  • Content Type Options ![Medium] Prevents Google Chrome and Internet Explorer from trying to mime-sniff the content-type of a response away from the one being declared by the server.
  • X-Frame-Options (XFO) ![Medium] Protects your visitors against clickjacking attacks.

⬆ back to top


Performance

Best practices

  • Weight page: High The weight of each page is between 0kb and 500kb
  • 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).

  • Cookie size: If you are using cookies be sure each cookie doesn't exceed 4096 bytes and your domaine name don't have more than 20 cookies.

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 displayed, 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 submitted to Google Search Console (ex: Google Webmaster Tools)
  • robots.txt: High The robots.txt is not blocking webpages
  • Structured Data: High Pages using structured data are tested and are without errors. Structured data helps crawlers understand the content in the current page.
  • 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

CC0 1.0 Universal Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. For more information, please see <http://creativecommons.org/publicdomain/zero/1.0/>

简介

The perfect Front-End Checklist for modern websites and meticulous developers 展开 收起
CC0-1.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/kangxiok/Front-End-Checklist.git
git@gitee.com:kangxiok/Front-End-Checklist.git
kangxiok
Front-End-Checklist
Front-End-Checklist
master

搜索帮助