]> source.dussan.org Git - jquery.git/commitdiff
Docs: add note about code organization with AMD
authorTimmy Willison <timmywillisn@gmail.com>
Thu, 14 Jan 2016 17:24:33 +0000 (12:24 -0500)
committerTimmy Willison <timmywillisn@gmail.com>
Thu, 14 Jan 2016 18:09:40 +0000 (13:09 -0500)
Fixes gh-2750
Close gh-2832

CONTRIBUTING.md

index 3ed61a4b3984dd99e10833b90a2b13505d6ab66a..f7d52141b594588ec25eb3898ea9821e91864b54 100644 (file)
@@ -134,6 +134,12 @@ Alternatively, you can **load tests in AMD** to avoid the need for rebuilding al
 Click "Load with AMD" after loading the test page.
 
 
+### Repo organization
+
+The jQuery source is organized with AMD modules and then concatenated and compiled at build time.
+
+jQuery also contains some special modules we call "var modules", which are placed in folders named "var". At build time, these small modules are compiled to simple var statements. This makes it easy for us to share variables across modules. Browse the "src" folder for examples.
+
 ### Browser support
 
 Remember that jQuery supports multiple browsers and their versions; any contributed code must work in all of them. You can refer to the [browser support page](https://jquery.com/browser-support/) for the current list of supported browsers.