/angular.js.git
-2. To go to the AngularJS directory, run:
+# Go to the AngularJS directory:
+cd angular.js
- cd angular.js
+# Add the main AngularJS repository as an upstream remote to your repository:
+git remote add upstream https://github.com/angular/angular.js.git
-3. To add the main AngularJS repository as an upstream remote to your repository, run:
+# Install node.js dependencies:
+npm install
- git remote add upstream https://github.com/angular/angular.js.git
+# Install bower components:
+bower install
-4. To add node.js dependencies
+# Build AngularJS:
+grunt package
+```
- npm install
-5. To add docs components
-
- bower install
-
-6. To build AngularJS, run:
-
- grunt package
-
-NOTE: If you're using Windows you must run your command line with administrative privileges (right click, run as
+
+**Note:** If you're using Windows you must run your command line with administrative privileges (right click, run as
Administrator).
-
+
The build output can be located under the `build` directory. It consists of the following files and
directories:
-* `angular-.zip` — This is the complete zip file, which contains all of the release build
+* `angular-.zip` — The complete zip file, containing all of the release build
artifacts.
* `angular.js` — The non-minified `angular` script.
@@ -167,34 +104,37 @@ artifacts.
* `docs/docs-scenario.html` — The End2End test runner for the documentation application.
-
## Running a Local Development Web Server
To debug code and run end-to-end tests, it is often useful to have a local HTTP server. For this purpose, we have
made available a local web server based on Node.js.
1. To start the web server, run:
-
- grunt webserver
-
-2. To access the local server, go to this website:
-
- http://localhost:8000/
-
+ ```shell
+ grunt webserver
+ ```
+
+2. To access the local server, enter the following URL into your web browser:
+ ```
+ http://localhost:8000/
+ ```
By default, it serves the contents of the AngularJS project directory.
-
## Running the Unit Test Suite
-Our unit and integration tests are written with Jasmine and executed with Karma. To run all of the
+We write unit and integration tests with Jasmine and execute them with Karma. To run all of the
tests once on Chrome run:
- grunt test:unit
+```shell
+grunt test:unit
+```
To run the tests on other browsers (Chrome, ChromeCanary, Firefox, Opera and Safari are pre-configured) use:
- grunt test:unit --browsers Opera,Firefox
+```shell
+grunt test:unit --browsers Opera,Firefox
+```
Note there should be _no spaces between browsers_. `Opera, Firefox` is INVALID.
@@ -203,96 +143,34 @@ change. To execute tests in this mode run:
1. To start the Karma server, capture Chrome browser and run unit tests, run:
- grunt autotest:jqlite
+ ```shell
+ grunt autotest
+ ```
-2. To capture more browsers, open this url in the desired browser (url might be different if you have multiple instance
- of Karma running, read Karma's console output for the correct url):
+2. To capture more browsers, open this URL in the desired browser (URL might be different if you have multiple instance
+ of Karma running, read Karma's console output for the correct URL):
- http://localhost:9876/
+ ```shell
+ http://localhost:9876/
+ ```
3. To re-run tests just change any source or test file.
To learn more about all of the preconfigured Grunt tasks run:
- grunt --help
-
-
-## Running the end-to-end Test Suite
-
-To run the E2E test suite:
-
-1. Start the local web server if it's not running already.
-
- grunt webserver
-
-2. In a browser, go to:
-
- http://localhost:8000/build/docs/docs-scenario.html
-
- or in terminal run:
-
- grunt test:end2end
-
-For convenience you can also simply run:
-
- grunt test:e2e
-
-This will start the webserver for you and run the tests.
-
-
-
-
-# Submitting Your Changes
-
-To create and submit a change:
-
-1.
- Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be
- accepted, the CLA must be signed. It's a quick process, we promise!
-
- For individuals we have a [simple click-through form](http://code.google.com/legal/individual-cla-v1.0.html). For
- corporations we'll need you to
- [print, sign and one of scan+email, fax or mail the form](http://code.google.com/legal/corporate-cla-v1.0.html).
-
-
-2. Create and checkout a new branch off the master branch for your changes:
-
- git checkout -b my-fix-branch master
-
-3. Create your patch, make sure to have plenty of tests (that pass).
-
-4. Commit your changes and create a descriptive commit message (the commit message is used to generate release notes,
- please check out our
- [commit message conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#)
- and our commit message presubmit hook `validate-commit-msg.js`):
-
- git commit -a
-
-5. Push your branch to Github:
-
- git push origin my-fix-branch
-
-6. In Github, send a pull request to `angular:master`.
-
-
-7. When the patch is reviewed and merged, delete your branch and pull yours — and other — changes
-from the main (upstream) repository:
-
- 1. To delete the branch in Github, run:
-
- git push origin :my-fix-branch
-
- 2. To check out the master branch, run:
+```shell
+grunt --help
+```
- git checkout master
- 3. To delete a local branch, run:
+## Running the End-to-end Test Suite
- git branch -D my-fix-branch
+Simply run:
- 4. To update your master with the latest upstream version, run:
+```shell
+grunt test:e2e
+```
- git pull --ff upstream master
+This will start the webserver and run the tests.
-That's it! Thank you for your contribution!
--
cgit v1.2.3