From ca25fc9a836ed063f521a154151892962af5beee Mon Sep 17 00:00:00 2001 From: Rob Larsen Date: Wed, 18 Aug 2021 10:54:36 -0400 Subject: [PATCH] replaces references to master with main --- .github/CONTRIBUTING.md | 8 ++++---- .github/ISSUE_TEMPLATE.md | 2 +- .github/workflows/test.yaml | 4 ++-- README.md | 4 ++-- dist/doc/css.md | 4 ++-- dist/doc/html.md | 40 ++++++++++++++++++------------------- src/doc/css.md | 4 ++-- src/doc/html.md | 40 ++++++++++++++++++------------------- 8 files changed, 53 insertions(+), 53 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5e774cb9..a3c666cd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,7 +45,7 @@ Guidelines for bug reports: reported. 2. **Check if the issue has been fixed** — try to reproduce it using the - latest `master` or development branch in the repository. + latest `main` or development branch in the repository. 3. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example. @@ -117,8 +117,8 @@ included in the project: 2. If you cloned a while ago, get the latest changes from upstream: ```bash - git checkout master - git pull upstream master + git checkout main + git pull upstream main ``` 3. Create a new topic branch (off the main project development branch) to @@ -137,7 +137,7 @@ included in the project: 5. Locally merge (or rebase) the upstream development branch into your topic branch: ```bash - git pull [--rebase] upstream master + git pull [--rebase] upstream main ``` 6. Push your topic branch up to your fork: diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index e36360df..3e9121f3 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -33,7 +33,7 @@ Guidelines for bug reports: just helps to get the (sometimes extensive) context. 2. **Check if the issue has been fixed** — try to reproduce it using the - latest `master` or development branch in the repository. + latest `main` or development branch in the repository. 3. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example. diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index bec13e1c..6882373f 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -2,9 +2,9 @@ name: Build status on: push: - branches: [master] + branches: [main] pull_request: - branches: [master] + branches: [main] jobs: build: diff --git a/README.md b/README.md index c454ced3..e540c198 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # [HTML5 Boilerplate](https://html5boilerplate.com/) -[![Build status](https://github.com/h5bp/html5-boilerplate/workflows/Build%20status/badge.svg)](https://github.com/h5bp/html5-boilerplate/actions?query=workflow%3A%22Build+status%22+branch%3Amaster) -[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/h5bp/html5-boilerplate/blob/master/LICENSE.txt) +[![Build status](https://github.com/h5bp/html5-boilerplate/workflows/Build%20status/badge.svg)](https://github.com/h5bp/html5-boilerplate/actions?query=workflow%3A%22Build+status%22+branch%3Amain) +[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/h5bp/html5-boilerplate/blob/main/LICENSE.txt) [![devDependency Status](https://david-dm.org/h5bp/html5-boilerplate/dev-status.svg)](https://david-dm.org/h5bp/html5-boilerplate#info=devDependencies) [![NPM Downloads](https://img.shields.io/npm/dt/html5-boilerplate.svg)](https://www.npmjs.com/package/html5-boilerplate) [![github-stars-image](https://img.shields.io/github/stars/h5bp/html5-boilerplate.svg?label=github%20stars)](https://github.com/h5bp/html5-boilerplate) diff --git a/dist/doc/css.md b/dist/doc/css.md index 40c96a60..63aba032 100644 --- a/dist/doc/css.md +++ b/dist/doc/css.md @@ -38,7 +38,7 @@ Several base styles are included that build upon `Normalize.css`. These styles: * and more... These styles are included in -[style.css](https://github.com/h5bp/html5-boilerplate/blob/master/dist/css/style.css) +[style.css](https://github.com/h5bp/html5-boilerplate/blob/main/dist/css/style.css) using [main.css](https://github.com/h5bp/main.css) project. -See the main.css [documentation](https://github.com/h5bp/main.css/blob/master/README.md#features) +See the main.css [documentation](https://github.com/h5bp/main.css/blob/main/README.md#features) for a full discussion of these styles. diff --git a/dist/doc/html.md b/dist/doc/html.md index ffebe360..8a5c944c 100644 --- a/dist/doc/html.md +++ b/dist/doc/html.md @@ -31,11 +31,11 @@ to the `lang` attribute in the `` as in this example: ### The order of the `` and `<meta>` tags The charset declaration (`<meta charset="utf-8">`) must be included completely -within the +within the [first 1024 bytes of the document](https://html.spec.whatwg.org/multipage/semantics.html#charset) and should be specified as early as possible (before any content that could be controlled by an attacker, such as a `<title>` element) in order to avoid a -potential +potential [encoding-related security issue](https://code.google.com/archive/p/doctype-mirror/wikis/ArticleUtf7.wiki) in Internet Explorer. @@ -49,15 +49,15 @@ results. <meta name="description" content="This is a description"> ``` -Google's +Google's [Create good meta descriptions](https://support.google.com/webmasters/answer/35624?hl=en#meta-descriptions) documentation has useful tips on creating an effective description. ### Mobile Viewport -There are a few different options that you can use with the -[`viewport` meta tag](https://docs.google.com/present/view?id=dkx3qtm_22dxsrgcf4 -"Viewport and Media Queries - The Complete Idiot's Guide"). +There are a few different options that you can use with the +[`viewport` meta tag](https://docs.google.com/present/view?id=dkx3qtm_22dxsrgcf4 +"Viewport and Media Queries - The Complete Idiot's Guide"). You can find out more in [ the MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag). HTML5 Boilerplate comes with a simple setup that strikes a good balance for general use cases. @@ -67,7 +67,7 @@ HTML5 Boilerplate comes with a simple setup that strikes a good balance for gene ``` If you want to take advantage of edge-to-edge displays of iPhone X/XS/XR you -can do so with additional viewport parameters. +can do so with additional viewport parameters. [Check the WebKit blog](https://webkit.org/blog/7929/designing-websites-for-iphone-x/) for details. @@ -119,9 +119,9 @@ It's linked to from the HTML as follows: ``` Our -[site.webmanifest](https://github.com/h5bp/html5-boilerplate/blob/master/src/site.webmanifest) +[site.webmanifest](https://github.com/h5bp/html5-boilerplate/blob/main/src/site.webmanifest) contains a very skeletal "app" definition, just to show the basic usage. You -should fill this file out with +should fill this file out with [more information about your site or application](https://developer.mozilla.org/en-US/docs/Web/Manifest) ### Favicons and Touch Icon @@ -151,8 +151,8 @@ Shiv). This allows you to target parts of your CSS and JavaScript based on the features supported by a browser. Starting with version 3 Modernizr can be customized using the -[modernizr-config.json](https://github.com/h5bp/html5-boilerplate/blob/master/modernizr-config.json) -and the +[modernizr-config.json](https://github.com/h5bp/html5-boilerplate/blob/main/modernizr-config.json) +and the [Modernizr command line utility](https://www.npmjs.com/package/modernizr-cli). ### What About Polyfills? @@ -177,7 +177,7 @@ polyfills are all loaded before any other JavaScript. There are some misconceptions about Modernizr and polyfills. It's important to understand that Modernizr just handles feature checking, not polyfilling itself. -The only thing Modernizr does regarding polyfills is that the team maintains +The only thing Modernizr does regarding polyfills is that the team maintains [a huge list of cross Browser polyfills](https://github.com/Modernizr/Modernizr/wiki/HTML5-Cross-Browser-Polyfills). ### jQuery @@ -210,18 +210,18 @@ To load jQuery from a CDN with a local fallback you can use the following: Finally, an optimized version of the Google Universal Analytics tracking code is included. -We use `analytics.js` rather than the newer `gtag.js` as +We use `analytics.js` rather than the newer `gtag.js` as [it's faster and supports tasks and plugins](https://github.com/philipwalton/analyticsjs-boilerplate/issues/19#issuecomment-333714370) -Starting with version 8.0.0 we, by default, -[anonymize IP addresses](https://support.google.com/analytics/answer/2763052). +Starting with version 8.0.0 we, by default, +[anonymize IP addresses](https://support.google.com/analytics/answer/2763052). By default Google Analytics records the full IP address of a user visiting the site, but that full IP address is never available to the Google Analytics property admin. By anonymizing the IP address you can make your site more GDPR-compliant as a full IP address can be defined as PII (personally identifiable information.) -The beacon transport mechanism is used to send all hits +The beacon transport mechanism is used to send all hits [which saves HTTP requests and improves performance](https://philipwalton.com/articles/the-google-analytics-setup-i-use-on-every-site-i-build/#loading-analytics.js). Google recommends that this script be placed at the top of the page. Factors to @@ -229,7 +229,7 @@ consider: if you place this script at the top of the page, you’ll be able to count users who don’t fully load the page, and you’ll incur the max number of simultaneous connections of the browser. -Please be aware that while Google +Please be aware that while Google [states that it is fully GDPR compliant](https://privacy.google.com/businesses/compliance/), it is still possible to use analytics to violate GDPR. @@ -240,8 +240,8 @@ Further information: * [Privacy Controls in Google Analytics](https://support.google.com/analytics/answer/9019185) **N.B.** The Google Analytics snippet is included by default mainly because -Google Analytics is -[currently one of the most popular tracking solutions](https://trends.builtwith.com/analytics/Google-Analytics) +Google Analytics is +[currently one of the most popular tracking solutions](https://trends.builtwith.com/analytics/Google-Analytics) out there. However, its usage isn't set in stone, and you SHOULD consider exploring the -[alternatives](https://en.wikipedia.org/wiki/List_of_web_analytics_software) +[alternatives](https://en.wikipedia.org/wiki/List_of_web_analytics_software) and use whatever suits your needs best. diff --git a/src/doc/css.md b/src/doc/css.md index 40c96a60..63aba032 100644 --- a/src/doc/css.md +++ b/src/doc/css.md @@ -38,7 +38,7 @@ Several base styles are included that build upon `Normalize.css`. These styles: * and more... These styles are included in -[style.css](https://github.com/h5bp/html5-boilerplate/blob/master/dist/css/style.css) +[style.css](https://github.com/h5bp/html5-boilerplate/blob/main/dist/css/style.css) using [main.css](https://github.com/h5bp/main.css) project. -See the main.css [documentation](https://github.com/h5bp/main.css/blob/master/README.md#features) +See the main.css [documentation](https://github.com/h5bp/main.css/blob/main/README.md#features) for a full discussion of these styles. diff --git a/src/doc/html.md b/src/doc/html.md index ffebe360..8a5c944c 100644 --- a/src/doc/html.md +++ b/src/doc/html.md @@ -31,11 +31,11 @@ to the `lang` attribute in the `<html>` as in this example: ### The order of the `<title>` and `<meta>` tags The charset declaration (`<meta charset="utf-8">`) must be included completely -within the +within the [first 1024 bytes of the document](https://html.spec.whatwg.org/multipage/semantics.html#charset) and should be specified as early as possible (before any content that could be controlled by an attacker, such as a `<title>` element) in order to avoid a -potential +potential [encoding-related security issue](https://code.google.com/archive/p/doctype-mirror/wikis/ArticleUtf7.wiki) in Internet Explorer. @@ -49,15 +49,15 @@ results. <meta name="description" content="This is a description"> ``` -Google's +Google's [Create good meta descriptions](https://support.google.com/webmasters/answer/35624?hl=en#meta-descriptions) documentation has useful tips on creating an effective description. ### Mobile Viewport -There are a few different options that you can use with the -[`viewport` meta tag](https://docs.google.com/present/view?id=dkx3qtm_22dxsrgcf4 -"Viewport and Media Queries - The Complete Idiot's Guide"). +There are a few different options that you can use with the +[`viewport` meta tag](https://docs.google.com/present/view?id=dkx3qtm_22dxsrgcf4 +"Viewport and Media Queries - The Complete Idiot's Guide"). You can find out more in [ the MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag). HTML5 Boilerplate comes with a simple setup that strikes a good balance for general use cases. @@ -67,7 +67,7 @@ HTML5 Boilerplate comes with a simple setup that strikes a good balance for gene ``` If you want to take advantage of edge-to-edge displays of iPhone X/XS/XR you -can do so with additional viewport parameters. +can do so with additional viewport parameters. [Check the WebKit blog](https://webkit.org/blog/7929/designing-websites-for-iphone-x/) for details. @@ -119,9 +119,9 @@ It's linked to from the HTML as follows: ``` Our -[site.webmanifest](https://github.com/h5bp/html5-boilerplate/blob/master/src/site.webmanifest) +[site.webmanifest](https://github.com/h5bp/html5-boilerplate/blob/main/src/site.webmanifest) contains a very skeletal "app" definition, just to show the basic usage. You -should fill this file out with +should fill this file out with [more information about your site or application](https://developer.mozilla.org/en-US/docs/Web/Manifest) ### Favicons and Touch Icon @@ -151,8 +151,8 @@ Shiv). This allows you to target parts of your CSS and JavaScript based on the features supported by a browser. Starting with version 3 Modernizr can be customized using the -[modernizr-config.json](https://github.com/h5bp/html5-boilerplate/blob/master/modernizr-config.json) -and the +[modernizr-config.json](https://github.com/h5bp/html5-boilerplate/blob/main/modernizr-config.json) +and the [Modernizr command line utility](https://www.npmjs.com/package/modernizr-cli). ### What About Polyfills? @@ -177,7 +177,7 @@ polyfills are all loaded before any other JavaScript. There are some misconceptions about Modernizr and polyfills. It's important to understand that Modernizr just handles feature checking, not polyfilling itself. -The only thing Modernizr does regarding polyfills is that the team maintains +The only thing Modernizr does regarding polyfills is that the team maintains [a huge list of cross Browser polyfills](https://github.com/Modernizr/Modernizr/wiki/HTML5-Cross-Browser-Polyfills). ### jQuery @@ -210,18 +210,18 @@ To load jQuery from a CDN with a local fallback you can use the following: Finally, an optimized version of the Google Universal Analytics tracking code is included. -We use `analytics.js` rather than the newer `gtag.js` as +We use `analytics.js` rather than the newer `gtag.js` as [it's faster and supports tasks and plugins](https://github.com/philipwalton/analyticsjs-boilerplate/issues/19#issuecomment-333714370) -Starting with version 8.0.0 we, by default, -[anonymize IP addresses](https://support.google.com/analytics/answer/2763052). +Starting with version 8.0.0 we, by default, +[anonymize IP addresses](https://support.google.com/analytics/answer/2763052). By default Google Analytics records the full IP address of a user visiting the site, but that full IP address is never available to the Google Analytics property admin. By anonymizing the IP address you can make your site more GDPR-compliant as a full IP address can be defined as PII (personally identifiable information.) -The beacon transport mechanism is used to send all hits +The beacon transport mechanism is used to send all hits [which saves HTTP requests and improves performance](https://philipwalton.com/articles/the-google-analytics-setup-i-use-on-every-site-i-build/#loading-analytics.js). Google recommends that this script be placed at the top of the page. Factors to @@ -229,7 +229,7 @@ consider: if you place this script at the top of the page, you’ll be able to count users who don’t fully load the page, and you’ll incur the max number of simultaneous connections of the browser. -Please be aware that while Google +Please be aware that while Google [states that it is fully GDPR compliant](https://privacy.google.com/businesses/compliance/), it is still possible to use analytics to violate GDPR. @@ -240,8 +240,8 @@ Further information: * [Privacy Controls in Google Analytics](https://support.google.com/analytics/answer/9019185) **N.B.** The Google Analytics snippet is included by default mainly because -Google Analytics is -[currently one of the most popular tracking solutions](https://trends.builtwith.com/analytics/Google-Analytics) +Google Analytics is +[currently one of the most popular tracking solutions](https://trends.builtwith.com/analytics/Google-Analytics) out there. However, its usage isn't set in stone, and you SHOULD consider exploring the -[alternatives](https://en.wikipedia.org/wiki/List_of_web_analytics_software) +[alternatives](https://en.wikipedia.org/wiki/List_of_web_analytics_software) and use whatever suits your needs best.