AMD: Note on AMD best practices

Fixes #14687
Closes gh-1478
(cherry picked from commit 19220c0f29fa60d80a2beb76f048ffc8b972ba35)

Conflicts:
	AUTHORS.txt

diff --git a/AUTHORS.txt b/AUTHORS.txt
index 0cee820c50ff9cc0730b560c7f2318169aa8e83b..07fb5710d27b5f452811eb45db8681344b813eb6 100644 (file)
--- a/AUTHORS.txt
+++ b/AUTHORS.txt
@@ -206,3 +206,4 @@ Jakob Stoeck <jakob@pokermania.de>
 cjqed <christopherjonesqed@gmail.com>
 Forbes Lindesay <forbes@lindesay.co.uk>
 John Paul <john@johnkpaul.com>
+S. Andrew Sheppard <andrew@wq.io>

diff --git a/src/exports/amd.js b/src/exports/amd.js
index 815b5d88afd9093bf7c2bb05e34fff45c121f87f..9a9846f9f6018525af8044c1ba56db81ef74902a 100644 (file)
--- a/src/exports/amd.js
+++ b/src/exports/amd.js
@@ -9,6 +9,12 @@ define([
 // derived from file names, and jQuery is normally delivered in a lowercase
 // file name. Do this after creating the global so that if an AMD module wants
 // to call noConflict to hide this version of jQuery, it will work.
+
+// Note that for maximum portability, libraries that are not jQuery should
+// declare themselves as anonymous modules, and avoid setting a global if an
+// AMD loader is present. jQuery is a special case. For more information, see
+// https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon
+
 if ( typeof define === "function" && define.amd ) {
        define( "jquery", [], function() {
                return jQuery;