Merge pull request #44 from knittingcodemonkey/addToReadme

docs(README.md, CONTRIBUTING.md): Update and Add respectively

Author: ladyleet

CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# Contributing to RxJS Docs
+
+[Read and abide by the Code of Conduct](CODE_OF_CONDUCT.md)! Even if you don't read it,
+it still applies to you. Ignorance is not an exemption.
+
+Contents
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
+  - [After your pull request is merged](#after-your-pull-request-is-merged)
+- [Commit Message Guidelines](#commit-message-guidelines)
+  - [Commit Message Format](#commit-message-format)
+  - [Revert](#revert)
+  - [Type](#type)
+  - [Scope](#scope)
+  - [Subject](#subject)
+  - [Body](#body)
+  - [Footer](#footer)
+
+  <!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+(This document is a work and progress and is subject to change)
+
+## Building/Testing
+
+The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:
+
+- start: runs the dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+- test: runs tests with `jasmine`, must have built prior to running.
+- build: build artifacts will be stored in the `dist/` directory
+- build-prod: builds for production using the `--prod` flag
+- commit: runs git commit wizard for passing rxjs-github-bot message validator
+
+## Submitting a Pull Request (PR)
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+* Search [GitHub](https://github.com/ReactiveX/rxjs-docs/pulls) for an open or closed PR
+  that relates to your submission. You don't want to duplicate effort.
+* Make your changes in a new git branch:
+
+     ```shell
+     git checkout -b my-fix-branch master
+     ```
+
+* Create your patch, following [code style guidelines](#coding-style-guidelines), and **including appropriate test cases**.
+* Run the full test suite and ensure that all tests pass.
+* Run the micro and macro performance tests against your feature branch and compare against master
+  to ensure performance wasn't changed for the worse.
+* Commit your changes using a descriptive commit message that follows our
+  [commit message guidelines](#commit-message-guidelines). Adherence to these conventions
+  is necessary because release notes are automatically generated from these messages.
+
+     ```shell
+     git commit -a
+     ```
+  Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
+
+* Push your branch to GitHub:
+
+    ```shell
+    git push origin my-fix-branch
+    ```
+
+* In GitHub, send a pull request to `rxjs-docs:master`.
+* If we suggest changes then:
+  * Make the required updates.
+  * Re-run the test suites to ensure tests are still passing.
+  * Re-run performance tests to make sure your changes didn't hurt performance.
+  * Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
+
+    ```shell
+    git rebase master -i
+    git push -f
+    ```
+
+That's it! Thank you for your contribution!
+
+
+### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull the changes
+from the main (upstream) repository:
+
+* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
+
+    ```shell
+    git push origin --delete my-fix-branch
+    ```
+
+* Check out the master branch:
+
+    ```shell
+    git checkout master -f
+    ```
+
+* Delete the local branch:
+
+    ```shell
+    git branch -D my-fix-branch
+    ```
+
+* Update your master with the latest upstream version:
+
+    ```shell
+    git pull --ff upstream master
+    ```
+
+
+- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
+## Commit Message Guidelines
+
+We have very precise rules over how our git commit messages can be formatted.  This leads to **more
+readable messages** that are easy to follow when looking through the **project history**. But also,
+we use the git commit messages to **generate the rxjs-docs change log**. Helper script `npm run commit`
+provides command line based wizard to format commit message easily.
+
+### Commit Message Format
+Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
+format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
+  semi-colons, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests
+* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
+  generation
+
+### Scope
+The scope could be anything specifying place of the commit change. For example
+`Observable`, `Subject`, `switchMap`, etc.
+
+### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize first letter
+* no dot (.) at the end
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

README.md

@@ -1,14 +1,34 @@
+[![Build Status](https://travis-ci.org/ReactiveX/rxjs-docs.svg?branch=master)](https://travis-ci.org/ReactiveX/rxjs-docs)
+
 # rxjs-docs
 The home for new work on the new RxJS docs (RxJS v5 and up)
 
-## Development server
+License is the same as the RxJS project: https://github.com/reactivex/rxjs
+
+[Apache 2.0 License](LICENSE.txt)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Contribution Guidelines](CONTRIBUTING.md)
 
-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.
+## Important
 
-## Build
+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.
 
-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.
+## Goals
 
-## License
+- Serve updated docs for RxJs
+- Serve multiple translations for the docs
+- Provide working examples
 
-License is the same as the RxJS project: https://github.com/reactivex/rxjs
+## Contributing
+
+More detailed information can be found in the [Contribution Guidelines](CONTRIBUTING.md)
+
+## Building/Testing
+
+The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:
+
+- start: runs the dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+- test: runs tests with `jasmine`, must have built prior to running.
+- build: build artifacts will be stored in the `dist/` directory
+- build-prod: builds for production using the `--prod` flag
+- commit: runs git commit wizard for passing rxjs-github-bot message validator

package.json

@@ -2,14 +2,20 @@
   "name": "rxjs-docs",
   "version": "0.0.0",
   "license": "MIT",
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
     "build": "ng build",
     "build-prod": "ng build --prod",
     "test": "ng test",
     "lint": "ng lint",
-    "e2e": "ng e2e"
+    "e2e": "ng e2e",
+    "commit": "git-cz"
   },
   "private": true,
   "dependencies": {
@@ -41,7 +47,10 @@
     "@types/node": "6.0.60",
     "angular2-template-loader": "0.6.2",
     "codelyzer": "3.1.1",
+    "commitizen": "^2.9.6",
+    "cz-conventional-changelog": "^2.0.0",
     "danger": "1.2.0",
+    "doctoc": "^1.3.0",
     "electron": "1.6.11",
     "jasmine-core": "2.6.2",
     "jasmine-spec-reporter": "4.1.0",
@@ -58,5 +67,8 @@
     "typescript": "2.3.3",
     "validate-commit-msg": "2.14.0",
     "wallaby-webpack": "*"
+  },
+  "engines": {
+    "npm": ">=2.0.0"
   }
 }