@page guides.Contributing Contributing @parent StealJS.guides Thank you for contributing! ## Bugs and Feature Requests Bugs and feature requests should be submitted to [steal](http://github.com/bitovi/steal/issues/new) for issues with module loading and [steal-tools](http://github.com/bitovi/steal-tools/issues/new) for issues building. The best issues are those submitted with tests. Learn about how to setup a test in the "Developing" sections below. ## Developing steal To develop steal, fork and clone [steal](http://github.com/bitovi/steal). Make sure you have NodeJS installed. Then: 1. Install npm modules > npm install 2. Install bower modules > bower install 3. Setup grunt watch > grunt watch This will automatically build `steal.js` and `steal.production.js` when anything in `src` changes. To __test__, open `test/test.html`, and make sure everything passes. ## Understanding steal's code `steal.js` packages two other projects: - [ES6ModuleLoader](https://github.com/ModuleLoader/es6-module-loader) - Provides the [Loader](steal#section_LoaderandSystemnamespaces) and [System](steal#section_LoaderandSystemnamespaces) Polyfill. - [SystemJS](https://github.com/systemjs/systemjs) - Provides most System extensions like [System.paths], [System.map] and the [syntax.amd AMD] and [syntax.CommonJS CommonJS] syntaxes. And `steal.js` includes everything in the `src` folder. On a high level, steal.js is organized like: /* ES6ModuleLoader */ /* - Promise polyfill */ !function(e){"object"==typeof ...} /* - Loader Polyfill */ /* - System Polyfill */ /* SystemJS */ (function(__$global) { /* meta, register, core, global, cjs, amd, map, plugins, bundles, versions, depCache extensions */ }); /* start.js * - wraps everything in a closure * - helpers that are useful everywhere */ (function(global){ // helpers var camelize, each, map, isString, extend, parseURI; /* normalize.js * - standalone normalize function */ var normalize = function(){} /* core.js * - starts `makeSteal` that makes `steal`. */ var makeSteal = function( System ){ var steal = function(){ ... } /* system-extension-ext.js * - the System.ext extension */ var addExt = function(loader) { .. }; addExt(System); /* system-extension-forward-slash.js * - module names that end in / */ var addForwardSlash = function(loader) { ... }; addForwardSlash(System); /* config.js * - overwrites System.config * - sets up System.env, System.stealPath, System.bundlesPath */ var setterConfig = function(...){...} setterConfig(System,{ ... }); /* startup.js * - defines startup code */ var getScriptOptions = function () { ... } steal.startup = function(config){ ... } /* make-steal-end.js * - closes `makeSteal` */ }; /* system-format-steal.js * - a System extension that adds the `steal` syntax */ function addSteal(loader) { ... } addSteal(System); /* end.js * - */ if (typeof window != 'undefined') { window.steal = makeSteal(System); window.steal.startup( oldSteal ); ... } else { require('systemjs'); global.steal = makeSteal(System); ... } })(typeof window == "undefined" ? global : window); ## Writing a steal test All tests are in `test/test.js`. Most tests create an iframe that opens another page like: asyncTest("test description", function(){ makeIframe("path/to/page.html"); }); That page typically uses steal to import some modules and when complete calls to the parent window's QUnit assertion methods. For example: