Skip to content
This repository was archived by the owner on Oct 1, 2018. It is now read-only.

Commit 84e507c

Browse files
author
Jennifer Luker
committed
docs(CONTRIBUTING.md and README.md): Improve Readme and Contributing info
Add goals, building/testing scripts information, and commit message info none
1 parent 3faf503 commit 84e507c

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,17 @@ Contents
2121

2222
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2323

24-
(This document is a work and progress and is subject to change)
24+
(This document is a work and progress and is subject to change)
25+
26+
## Building/Testing
27+
28+
The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:
29+
30+
- start: runs the dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
31+
- test: runs tests with `jasmine`, must have built prior to running.
32+
- build: build artifacts will be stored in the `dist/` directory
33+
- build-prod: builds for production using the `--prod` flag
34+
- commit: runs git commit wizard for passing rxjs-github-bot message validator
2535

2636
## Submitting a Pull Request (PR)
2737
Before you submit your Pull Request (PR) consider the following guidelines:

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,26 @@ License is the same as the RxJS project: https://github.com/reactivex/rxjs
99
- [Code of Conduct](CODE_OF_CONDUCT.md)
1010
- [Contribution Guidelines](CONTRIBUTING.md)
1111

12-
## Development server
12+
## Important
1313

14-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
14+
By contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.
1515

16-
## Build
16+
## Goals
1717

18-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
18+
- Serve updated docs for RxJs
19+
- Serve multiple translations for the docs
20+
- Provide working examples
1921

20-
## License
22+
## Contributing
2123

24+
More detailed information can be found in the [Contribution Guidelines](CONTRIBUTING.md)
2225

26+
## Building/Testing
27+
28+
The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:
29+
30+
- start: runs the dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
31+
- test: runs tests with `jasmine`, must have built prior to running.
32+
- build: build artifacts will be stored in the `dist/` directory
33+
- build-prod: builds for production using the `--prod` flag
34+
- commit: runs git commit wizard for passing rxjs-github-bot message validator

0 commit comments

Comments
 (0)