v0.2.5 (#43)

* feat(core): `tests` folder renamed to `test` (with associated  updates to npm scripts)
* feat(test): test/mocha.opts file created to contain mocha options (makes npm scripts more readable)
* feat(docs): github contributing files added (`.github/CONTRIBUTING.md`, `.github/ISSUE_TEMPLATE.md`, `.github/PULL_REQUEST_TEMPLATE.md`)
* fix(docs): fix typos within getting started section of `README.md`

Author: prescottprue

.github/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing Guidelines
+
+Thanks for taking the time to look into contributing! Below are some basic conventions for contributing to this project.
+
+### General
+
+Please make sure that there aren't existing pull requests attempting to address the issue mentioned. Likewise, please check for issues related to update, as someone else may be working on the issue in a branch or fork.
+
+* Non-trivial changes should be discussed in an issue or on [gitter](https://gitter.im/redux-firebase/Lobby) or within an issue first
+* Develop in a topic branch, not master
+* Squash your commits
+
+### Commit Message Format
+
+Each commit message should include a **type**, a **scope** and a **subject**:
+
+```
+ <type>(<scope>): <subject>
+```
+
+Lines should not exceed 100 characters. This allows the message to be easier to read on github as well as in various git tools and produces a nice, neat commit log ie:
+
+```
+ #218 docs(example): allow user to configure webpack stats output
+ #271 feat(standard): add style config and refactor to match
+ #270 fix(config): only override publicPath when served by webpack
+ #269 feat(eslint-config-defaults): replace eslint-config-airbnb
+ #268 feat(config): allow user to configure webpack stats output
+```
+
+#### 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 or adds a feature
+* **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 `webpack`,
+`babel`, `redux` 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

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+**Do you want to request a *feature* or report a *bug*?**  
+
+
+**What is the current behavior?**
+
+
+**What is the expected behavior?**
+
+
+**Which versions of dependencies, and which browser are affected by this issue? Did this work in previous versions or setups?**
+
+
+**Steps to reproduce and if possible a minimal demo of the problem via [codesandbox](https://codesandbox.io/) or similar.**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+### Description
+
+
+### Check List
+If not relevant to pull request, check off as complete
+
+- [ ] All tests passing
+- [ ] Docs updated with any changes or examples if applicable
+- [ ] Added tests to ensure new feature(s) work properly
+
+### Relevant Issues
+<!-- * #1 -->

README.md

@@ -44,11 +44,11 @@ import 'firebase/firestore'
 const firebaseConfig = {} // from Firebase Console
 
 // Initialize firebase instance
-const firebaseApp = firebase.initializeApp(config)
+const firebaseApp = firebase.initializeApp(firebaseConfig)
 // Initialize Cloud Firestore through Firebase
 firebase.firestore();
 
-// Add reduxReduxFirebase to compose
+// Add reduxFirestore store enhancer to store creator
 const createStoreWithFirebase = compose(
   reduxFirestore(firebaseApp), // firebase instance as first argument
 )(createStore)
@@ -66,7 +66,11 @@ const store = createStoreWithFirebase(rootReducer, initialState)
 Then pass store to your component's context using [react-redux's `Provider`](https://github.com/reactjs/react-redux/blob/master/docs/api.md#provider-store):
 
 ```js
-ReactDOM.render(
+import React from 'react';
+import { render } from 'react-dom';
+import { Provider } from 'react-redux';
+
+render(
   <Provider store={store}>
     <MyRootComponent />
   </Provider>,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-firestore",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Redux bindings for Firestore.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -22,9 +22,8 @@
     "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack",
     "build": "npm run build:commonjs && npm run build:es && npm run build:umd && npm run build:umd:min",
     "watch": "npm run build:es -- --watch",
-    "start": "webpack-dev-server --config example/webpack.config.js",
-    "test": "mocha -R spec ./tests/setup.js ./tests/** --recursive --require babel-core/register",
-    "test:cov": "istanbul cover ./node_modules/mocha/bin/_mocha -- ./tests/** --recursive --report lcov --require babel-core/register",
+    "test": "mocha -R spec ./test/unit/**",
+    "test:cov": "istanbul cover ./node_modules/mocha/bin/_mocha ./test/unit/**",
     "codecov": "cat coverage/lcov.info | codecov",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",

package.json

@@ -0,0 +1,5 @@
+--require babel-core/register
+--require ./test/setup
+--recursive
+--colors
+--report lcov