From e0c25abb435db6e210d00407af2ba40e5f0b56ad Mon Sep 17 00:00:00 2001 From: Timmy Willison Date: Mon, 16 Nov 2015 15:49:59 -0500 Subject: [PATCH] Docs: add a note about loading source with AMD - Moves the note about the watch task and the note about loading with AMD to their own section under "Test Suite Tips" Fixes gh-2714 Close gh-2725 --- CONTRIBUTING.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f6547c56..cd6ab6fc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,12 +101,6 @@ Run the build script $ npm run build ``` -Run the Grunt tools: - -```bash -$ grunt && grunt watch -``` - Now open the jQuery test suite in a browser at http://localhost/test. If there is a port, be sure to include it. Success! You just built and tested jQuery! @@ -118,13 +112,26 @@ During the process of writing your patch, you will run the test suite MANY times Example: -http://localhost/test/?filter=css +http://localhost/test/?module=css This will only run the "css" module tests. This will significantly speed up your development and debugging. **ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!** +#### Loading changes on the test page + +Rather than rebuilding jQuery with `grunt` every time you make a change, you can use the included `grunt watch` task to rebuild distribution files whenever a file is saved. + +```bash +$ grunt watch +``` + +Alternatively, you can **load tests in AMD** to avoid the need for rebuilding altogether. + +Click "Load with AMD" after loading the test page. + + ### 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](http://jquery.com/browser-support/) for the current list of supported browsers.