added CONTRIBUTING.md && added merging section in How To's && general…

… README.md improvements

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+## Submitting Pull Requests
+
+**Please follow these basic steps to simplify pull request reviews - if you don't you'll probably just be asked to anyway.**
+
+* Please rebase your branch against the current master
+* Run ```npm install``` to make sure your development dependencies are up-to-date
+* Please ensure that the test suite passes **and** that code is lint free before submitting a PR by running:
+ * ```npm test```
+* If you've added new functionality, **please** include tests which validate its behaviour
+* Make reference to possible [issues](https://github.com/NathanWalker/angular2-seed-advanced/issues) on PR comment
+
+## Submitting bug reports
+
+* Please detail the affected browser(s) and operating system(s)
+* Please be sure to state which version of node **and** npm you're using

README.md

@@ -3,7 +3,12 @@
 This is a simple hapijs (nodejs) starter template that should be used as an api.
 It is inspired by [dwyl/hapi-typescript-example](https://github.com/dwyl/hapi-typescript-example/tree/master/src).
 
+# Table of Contents
+
+- [Contributing](#contributing)
+
 # Features
+- TODO
 
 # Installation
 
@@ -23,6 +28,17 @@ Running on port 3000 ex: localhost:3000/documentation
 
 # How To's
 
+## Merging latest upstream changes
+
+1. `npm run merge.preview` - This will fetch `upstream` and show you how the merge would look
+2. `npm run merge` - This will actually do the merge
+3. Handle any conflicts to get latest upstream into your application.
+4. Continue building your app.
+
+You can read more about [syncing a fork here](https://help.github.com/articles/syncing-a-fork/).
+
+If you have any suggestions to this workflow, please post [here](https://github.com/divramod/hapi-seed-advanced/issues).
+
 ## how to use in your project
 There are at least two ways to integrate the api in your project. As a submodule to an existing project or as standalone project.
 
@@ -51,6 +67,10 @@ git remote add upstream https://github.com/divramod/hapi-seed-advanced.git
 * src/libs/repository/interfaces.ts --> add entity interface (shortcut: )
 * src/libs/repository/mongo/ENTITYNAMERepostory.ts --> add repository (shortcut: )
 
+# Contributing
+
+Please see the [CONTRIBUTING](https://github.com/NathanWalker/hapi-seed-advanced/blob/master/CONTRIBUTING.md) file for guidelines.
+
 # ToDo's
 - [ ] create a npm module to help with the How To's
 - [ ] docs: add a section where i describe how to use it in your own project