Skip to content

Commit d4b8a86

Browse files
srawlinsmhevery
authored andcommitted
Updating DEVELOPER.md with nits and grammar fixes.
These are mostly trivial, but I thought I'd fix them while reading through the doc. Closes angular#1438
1 parent 642e7e5 commit d4b8a86

File tree

1 file changed

+36
-33
lines changed

1 file changed

+36
-33
lines changed

DEVELOPER.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ following products on your development machine:
2525
Dartium (a version of [Chromium](http://www.chromium.org) with native support for Dart through
2626
the Dart VM). One of the **simplest** ways to get both is to install the **Dart Editor bundle**,
2727
which includes the editor, SDK and Dartium. See the [Dart tools](https://www.dartlang.org/tools)
28-
download [page for instructions](https://www.dartlang.org/tools/download.html); note that you can
28+
download [page for instructions](https://www.dartlang.org/tools/download.html). You can also
2929
download both **stable** and **dev** channel versions from the [download
3030
archive](https://www.dartlang.org/tools/download-archive).
3131

32-
* [Git](http://git-scm.com) and/or the **Github app** (for [Mac](http://mac.github.com) or
33-
[Windows](http://windows.github.com)): the [Github Guide to Installing
32+
* [Git](http://git-scm.com) and/or the **GitHub app** (for [Mac](http://mac.github.com) or
33+
[Windows](http://windows.github.com)); [GitHub's Guide to Installing
3434
Git](https://help.github.com/articles/set-up-git) is a good source of information.
3535

36-
* [Node.js](http://nodejs.org) which is used to run a development web server, run tests, and
37-
generate distributable files. We also use Node's Package Manager (`npm`). Depending on your
38-
system, you can install Node either from source or as a pre-packaged bundle.
36+
* [Node.js](http://nodejs.org), which is used to run a development web server, run tests, and
37+
generate distributable files. We also use Node's Package Manager, `npm`, which comes with Node.
38+
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
3939

4040
* [Chrome Canary](https://www.google.com/chrome/browser/canary.html), a version of Chrome with
4141
bleeding edge functionality, built especially for developers (and early adopters).
@@ -45,17 +45,17 @@ following products on your development machine:
4545

4646
## Getting the Sources
4747

48-
Forking and cloning the Angular repository:
48+
Fork and clone the Angular repository:
4949

50-
1. Login to your Github account or create one by following the instructions given
50+
1. Login to your GitHub account or create one by following the instructions given
5151
[here](https://github.com/signup/free).
5252
2. [Fork](http://help.github.com/forking) the [main Angular
5353
repository](https://github.com/angular/angular).
5454
3. Clone your fork of the Angular repository and define an `upstream` remote pointing back to
55-
the Angular repository that you forked in the first place:
55+
the Angular repository that you forked in the first place.
5656

5757
```shell
58-
# Clone your Github repository:
58+
# Clone your GitHub repository:
5959
git clone [email protected]:<github username>/angular.git
6060

6161
# Go to the Angular directory:
@@ -93,7 +93,7 @@ PATH+=":$DART_SDK/bin"
9393

9494
## Installing NPM Modules and Dart Packages
9595

96-
Next, install the modules and packages needed to build Angular and run tests:
96+
Next, install the JavaScript modules and Dart packages needed to build and test Angular:
9797

9898
```shell
9999
# Install Angular project dependencies (package.json)
@@ -117,7 +117,7 @@ use in these instructions.
117117

118118
## Build commands
119119

120-
To build Angular and prepare tests run:
120+
To build Angular and prepare tests, run:
121121

122122
```shell
123123
$(npm bin)/gulp build
@@ -126,14 +126,15 @@ $(npm bin)/gulp build
126126
Notes:
127127
* Results are put in the `dist` folder.
128128
* This will also run `pub get` for the subfolders in `modules` and run `dartanalyzer` for
129-
every file that matches `<module>/src/<module>.dart`, e.g. `di/src/di.dart`
129+
every file that matches `<module>/src/<module>.dart`, e.g. `di/src/di.dart`.
130130

131131
You can selectively build either the JS or Dart versions as follows:
132132

133133
* `$(npm bin)/gulp build.js`
134134
* `$(npm bin)/gulp build.dart`
135135

136-
To clean out the `dist` folder use:
136+
To clean out the `dist` folder, run:
137+
137138
```shell
138139
$(npm bin)/gulp clean
139140
```
@@ -142,8 +143,8 @@ $(npm bin)/gulp clean
142143

143144
### Full test suite
144145

145-
* `npm test`: full test suite for both JS and Dart versions of Angular. These are the same tests as
146-
those run on Travis.
146+
* `npm test`: full test suite for both JS and Dart versions of Angular. These are the same tests
147+
that run on Travis.
147148

148149
You can selectively run either the JS or Dart versions as follows:
149150

@@ -159,7 +160,7 @@ You can run just the unit tests as follows:
159160
* `$(npm bin)/gulp test.unit.cjs`: JS tests in NodeJS; runs in **watch mode**.
160161
* `$(npm bin)/gulp test.unit.dart`: Dart tests in Dartium; runs in **watch mode**.
161162

162-
If you prefer running tests in "single-run" mode rather than watch mode use:
163+
If you prefer running tests in "single-run" mode rather than watch mode, run:
163164

164165
* `$(npm bin)/gulp test.unit.js/ci`
165166
* `$(npm bin)/gulp test.unit.cjs/ci`
@@ -171,25 +172,25 @@ much easier to debug. `xit` and `xdescribe` can also be useful to exclude a test
171172
tests respectively.
172173

173174
**Note for transpiler tests**: The karma preprocessor is setup in a way so that after every test
174-
run the transpiler is reloaded. With that it is possible to make changes to the preprocessor and
175+
run the transpiler is reloaded. Therefore it is possible to make changes to the preprocessor and
175176
run the tests without exiting karma (just touch a test file that you would like to run).
176177

177178
### E2e tests
178179

179180
1. `$(npm bin)/gulp build.js.cjs` (builds benchpress and tests into `dist/js/cjs` folder).
180-
2. `$(npm bin)/gulp serve.js.prod serve.js.dart2js` (runs local webserver).
181+
2. `$(npm bin)/gulp serve.js.prod serve.js.dart2js` (runs a local webserver).
181182
3. `$(npm bin)/protractor protractor-js.conf.js`: JS e2e tests.
182-
4. `$(npm bin)/protractor protractor-dart2js.conf.js`: Dart2JS e2e tests.
183+
4. `$(npm bin)/protractor protractor-dart2js.conf.js`: dart2js e2e tests.
183184

184185
Angular specific command line options when running protractor:
185186
- `$(npm bin)/protractor protractor-{js|dart2js}-conf.js --ng-help`
186187

187188
### Performance tests
188189

189190
1. `$(npm bin)/gulp build.js.cjs` (builds benchpress and tests into `dist/js/cjs` folder)
190-
2. `$(npm bin)/gulp serve.js.prod serve.js.dart2js` (runs local webserver)
191+
2. `$(npm bin)/gulp serve.js.prod serve.js.dart2js` (runs a local webserver)
191192
3. `$(npm bin)/protractor protractor-js.conf.js --benchmark`: JS performance tests
192-
4. `$(npm bin)/protractor protractor-dart2js.conf.js --benchmark`: Dart2JS performance tests
193+
4. `$(npm bin)/protractor protractor-dart2js.conf.js --benchmark`: dart2js performance tests
193194

194195
Angular specific command line options when running protractor (e.g. force gc, ...):
195196
`$(npm bin)/protractor protractor-{js|dart2js}-conf.js --ng-help`
@@ -204,10 +205,10 @@ Angular specific command line options when running protractor (e.g. force gc, ..
204205

205206
### File suffixes
206207

207-
* `*.js`: javascript files that get transpiled to Dart and EcmaScript 5
208-
* `*.es6`: javascript files that get transpiled only to EcmaScript 5
209-
* `*.es5`: javascript files that don't get transpiled
210-
* `*.dart`: dart files that don't get transpiled
208+
* `*.js`: JavaScript files that get transpiled to Dart and EcmaScript 5
209+
* `*.es6`: JavaScript files that get transpiled only to EcmaScript 5
210+
* `*.es5`: JavaScript files that don't get transpiled
211+
* `*.dart`: Dart files that don't get transpiled
211212

212213
## CI using Travis
213214

@@ -243,16 +244,18 @@ Notes:
243244

244245
If you need to debug the tests:
245246

246-
- add a `debugger;` statement to the test you want to debug (oe the source code),
247+
- add a `debugger;` statement to the test you want to debug (or the source code),
247248
- execute karma `$(npm bin)/gulp test.js`,
248249
- press the top right "DEBUG" button,
249-
- open the dev tools and press F5,
250-
- the execution halt at the `debugger;` statement
250+
- open the DevTools and press F5,
251+
- the execution halts at the `debugger;` statement
251252

252253
**Note (WebStorm users)**:
253-
You can create a Karma run config from WebStorm.
254-
Then in the "Run" menu, press "Debug 'karma-js.conf.js'", WebStorm will stop in the generated code
255-
on the `debugger;` statement.
256-
You can then step into the code and add watches.
254+
255+
1. Create a Karma run config from WebStorm.
256+
2. Then in the "Run" menu, press "Debug 'karma-js.conf.js'", and WebStorm will stop in the generated
257+
code on the `debugger;` statement.
258+
3. You can then step into the code and add watches.
259+
257260
The `debugger;` statement is needed because WebStorm will stop in a transpiled file. Breakpoints in
258261
the original source files are not supported at the moment.

0 commit comments

Comments
 (0)