Implement React [email protected]

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+## Quick Start
+Fork this project, then:
+```
+npm install
+npm start
+```
+Submit a pull request to the master branch to request merging your change.
+
+## Branch Organization
+All features should be worked out of a well named feature branch. Branch off the master branch.  Submit a pull request to merge your work into the master branch when your work is ready for review.
+
+## npm Scripts
+This project uses npm scripts for automation
+
+|Script|Description|
+|------|-----------|
+|start|Start local webserver to host the docs at localhost:3000|
+|test|Run tests|
+
+There are many other scripts in package.json, but these are the two you're most likely to run.
+
+## Semantic Versioning
+This project follows [semantic versioning](http://semver.org). We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes.
+
+## Proposing a Change
+If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. This lets us reach an agreement on your proposal before you put significant effort into it.
+
+## Style Guide
+ESLint will catch most styling issues that may exist in your code. You can check the status of your code styling by running npm start.
+
+However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at [Airbnb's Style Guide](https://github.com/airbnb/javascript) will guide you in the right direction.
+
+## Code Conventions
+- Use semicolons ;
+- 2 spaces for indentation (no tabs). Install the [Editorconfig](http://editorconfig.org) plugin for your editor to enforce this automatically.
+- Prefer ' over "

README.md

@@ -51,7 +51,17 @@ This will run the automated build process, start up a webserver, and open the ap
 4. Make sure files with names that begin with a dot (.babelrc, .editorconfig, .eslintrc) are copied to the project directory root. This is easy to overlook if you copy this repository manually.
 5. Don't run the project from a symbolic link. It may cause issues with file watches.
 6. Delete any .eslintrc that you're storing in your user directory. Also, disable any ESLint plugin / custom rules that you've enabled within your editor. These will conflict with the ESLint rules defined in this project.
-7. Make sure you don't have NODE_ENV set to production on your machine. If you do then the [development dependencies won't be installed](https://github.com/coryhouse/react-slingshot/issues/400#issuecomment-290497767). Here's [how to check](http://stackoverflow.com/a/27939821/26180). 
+7. Make sure you don't have NODE_ENV set to production on your machine. If you do then the [development dependencies won't be installed](https://github.com/coryhouse/react-slingshot/issues/400#issuecomment-290497767). Here's [how to check](http://stackoverflow.com/a/27939821/26180).
+8. Tip: Things to check if you get an `npm run lint` error or build error:
+
+    * If ESW found an error or warning in your project (e.g. console statement or a missing semi-colon), the lint thread will exit with `Exit status 1`. To fix: 
+
+      1. Change the `npm run lint` script to `"esw webpack.config.* src tools; exit 0"`
+      1. Change the `npm run lint:watch` script to `"esw webpack.config.* src tools --watch; exit 0"`
+
+      > Note: Adding `exit 0` will allow the npm scripts to ignore the status 1 and allow ESW to print all warnings and errors.
+
+    * Ensure the `eslint`/`esw` globally installed version matches the version used in the project. This will ensure the `esw` keyword is resolved.
 
 ## Technologies
 Slingshot offers a rich development experience using the following technologies: