Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit 3a9b170

Browse files
committed
docs: update the build instructions
1 parent 85c5024 commit 3a9b170

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

README.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -416,43 +416,33 @@ The tests ([see below](#testing)) exercise these examples.
416416

417417
# Build Instructions
418418

419-
Mostly gulp driven.
419+
Follow these steps for updating the library.
420420

421-
The following describes steps for updating from one Angular version to the next
421+
- `gulp bump` - up the package version number.
422422

423-
>This is essential even when there are no changes of real consequence.
424-
Neglecting to synchronize Angular 2 versions
425-
triggers typescript definition duplication error messages when
426-
compiling your application project.
423+
- update `CHANGELOG.md` to record the change. Call out _breaking changes_.
427424

428-
- `gulp bump` - up the package version number
425+
- update `READM.md` if usage or interfaces change.
429426

430-
- update `CHANGELOG.MD` to record the change
427+
- consider updating the dependency versions in `package.json`.
431428

432-
- update the dependent version(s) in `package.json`
429+
- `npm install` the new package(s) if you did.
433430

434-
- `npm install` the new package(s) (make sure they really do install!)<br>
435-
`npm list --depth=0`
431+
- `npm list --depth=0` to make sure they really did install!
436432

437-
- consider updating typings, install individually/several:
438-
```
439-
npm install @types/jasmine @types/node --save-dev
440-
```
441-
442-
- `gulp clean` - clear out all generated `text`
433+
- `gulp clean` to delete all generated files.
443434

444-
- `npm run build` to confirm the project compiles w/o error (sanity check)
435+
- `npm test` to dev-build and run tests (see ["Testing"](#testing) below).
445436

446-
- `npm test` to build and run tests (see ["Testing"](#testing) below)
437+
- `gulp build` to build for distribution.
447438

448-
- `gulp build`
449-
- commit and push
439+
- git add, commit, and push.
450440

451441
- `npm publish`
452442

453-
- Fix and validate angular.io docs samples
443+
- Confirm that angular.io docs samples still work
454444

455-
- Add two tags to the release commit with for unpkg
445+
- Add two tags to the release commit in github
456446
- the version number
457447
- 'latest'
458448

0 commit comments

Comments
 (0)