aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTimmy Willison <timmywillisn@gmail.com>2016-01-14 12:24:33 -0500
committerTimmy Willison <timmywillisn@gmail.com>2016-01-14 13:09:40 -0500
commitdbc4608ed10bd1347649e6f1514f459957cda003 (patch)
treedc74ef72f369dc54b3ea36b1fcc40578b54a1d2c
parent10c1254d159dbd3d78e8afca590fe53b0c6dfa26 (diff)
downloadjquery-dbc4608ed10bd1347649e6f1514f459957cda003.tar.gz
jquery-dbc4608ed10bd1347649e6f1514f459957cda003.zip
Docs: add note about code organization with AMD
Fixes gh-2750 Close gh-2832
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3ed61a4b3..f7d52141b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.