Merge pull request #155 from webpack/release/0.1

Release/0.1

Author: sokra

.eslintrc

@@ -9,6 +9,10 @@
         "node": true
     },
 
+    "plugins": [
+        "markdown"
+    ],
+    
     rules: {
         "no-undef": 2,
         "no-unreachable": 2,

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing
+
+From adding an issue for a documentation suggestion to creating a pull request: every contribution is
+appreciated and welcome. If you're planning to implement a new section or page 
+please create an issue first.
+
+## Setup
+
+* Install [Node.js](https://nodejs.org/) if you have not already.  
+  *Note: Node 6 or greater may be required for "best results".*
+* Fork the **webpack.io** repo at [https://github.com/webpack/webpack.io](https://github.com/webpack/webpack.io).
+* `git clone <your-clone-url> && cd webpack.io`
+* `git checkout develop`
+* `npm install`
+* `npm run build`
+* `npm start`
+* Visit [http://localhost:3000](http://localhost:3000) to preview your changes before making a pull request.
+
+## Branching Your Changes
+
+Making a branch in your fork for your contribution is helpful in the following ways:  
+* It allows you to have multiple contributions in as PRs at once.
+* It allows us to identify what your contribution is about from the branch name.
+
+You will want to checkout the `develop` branch locally before creating your new branch.
+
+There are two types of branches:
+* Feature
+* Hotfix
+
+### Features
+If your contribution is something new, like a new section or page or a new chunk 
+to an existing page, you can create a branch with the 
+following naming convetion:  
+```
+feature/<the-new-feature>
+```
+So, for example, if you are adding a page on how to write a custom loader your 
+branch could have the name:
+```
+feature/add-custom-loaders-page
+```
+
+### Fixes
+If you are fixing existing content or code you can create a branch with the 
+following naming convention:
+```
+hotfix/<the-fix>
+```
+So, for example, if you are fixing spelling on the api configuration page for 
+an option, your branch could have the name:
+```
+hotfix/fix-option-property-spelling-on-api-configuration
+```
+
+## Submitting Changes
+
+After getting some feedback, push to your fork branch and submit a pull request. We
+may suggest some changes or improvements or alternatives, but for small changes
+your pull request should be accepted quickly.
+
+Issue the PR to the [develop](https://github.com/webpack/webpack.io/tree/develop) branch.  
+
+## Thank you!
+
+Webpack is insanely feature rich and documentation is a huge time sink. We
+greatly appreciate any time spent fixing typos or clarifying sections in the
+documentation.

README.md

@@ -10,6 +10,8 @@ To develop, please pull the project, `cd` into the directory and run:
 - `npm run build` to create a production version of the site.
 - `npm start` to develop on a local webpack-dev-server (should be [here](http://localhost:3000/)).
 
+For more information see the [contributors page](https://github.com/webpack/webpack.io/blob/develop/CONTRIBUTING.md)
+
 ## Content Progress
 
 Fully completed can be removed from this list. If there's a topic you would like to contribute in, check out the related issue and comment there.
@@ -20,18 +22,24 @@ Fully completed can be removed from this list. If there's a topic you would like
 * Changelog - ![](https://img.shields.io/badge/progress-0%25-yellowgreen.svg)
 * Contribute - ![](https://img.shields.io/badge/progress-10%25-yellowgreen.svg)
 * Get Started - ![](https://img.shields.io/badge/progress-10%25-yellowgreen.svg) - [#15](https://github.com/webpack/webpack.io/issues/15)
-* License - ![](https://img.shields.io/badge/progress-100%25-yellowgreen.svg)
 * Writer's Guide - ![](https://img.shields.io/badge/progress-50%25-yellowgreen.svg)
 
+#### Done
+
+* License - ![](https://img.shields.io/badge/progress-100%25-green.svg)
+
 ### `/api`
 
-* CLI - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#24](https://github.com/webpack/webpack.io/issues/24)
 * Configuration - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#25](https://github.com/webpack/webpack.io/issues/25)
 * Loaders - ![](https://img.shields.io/badge/progress-0%25-yellowgreen.svg) - [#21](https://github.com/webpack/webpack.io/issues/21)
 * Module Resolution - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#12](https://github.com/webpack/webpack.io/issues/12)
 * Node - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#23](https://github.com/webpack/webpack.io/issues/23)
 * Plugins - ![](https://img.shields.io/badge/progress-0%25-yellowgreen.svg) - [#37](https://github.com/webpack/webpack.io/issues/37)
 
+#### Done
+
+* CLI - ![](https://img.shields.io/badge/progress-100%25-green.svg) - [#24](https://github.com/webpack/webpack.io/issues/24)
+
 ### `/concepts`
 
 * Compared to other systems - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#48](https://github.com/webpack/webpack.io/issues/48)
@@ -40,14 +48,15 @@ Fully completed can be removed from this list. If there's a topic you would like
 * Loaders - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#50](https://github.com/webpack/webpack.io/issues/50)
 * Output - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#10](https://github.com/webpack/webpack.io/issues/10)
 * Plugins - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#51](https://github.com/webpack/webpack.io/issues/51)
-* Targets - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#14](https://github.com/webpack/webpack.io/issues/14)
+
+#### Done
+
+* Targets - ![](https://img.shields.io/badge/progress-100%25-green.svg) - [#14](https://github.com/webpack/webpack.io/issues/14)
 
 ### `/how-to`
 
 * Author libraries - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#9](https://github.com/webpack/webpack.io/issues/9)
-* Cache - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#2](https://github.com/webpack/webpack.io/issues/2)
 * Develop - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#26](https://github.com/webpack/webpack.io/issues/26)
-* Generate a production build - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#11](https://github.com/webpack/webpack.io/issues/11)
 * Handle compatibility - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#4](https://github.com/webpack/webpack.io/issues/4)
 * Handle dependencies - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#5](https://github.com/webpack/webpack.io/issues/5)
 * Improve build performance - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#16](https://github.com/webpack/webpack.io/issues/16)
@@ -57,6 +66,11 @@ Fully completed can be removed from this list. If there's a topic you would like
 * Use with Docker - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#44](https://github.com/webpack/webpack.io/issues/44)
 * Use with third party tools - ![](https://img.shields.io/badge/progress-5%25-yellowgreen.svg) - [#53](https://github.com/webpack/webpack.io/issues/53)
 
+#### Done
+
+* Cache - ![](https://img.shields.io/badge/progress-100%25-green.svg) - [#2](https://github.com/webpack/webpack.io/issues/2)
+* Generate a production build - ![](https://img.shields.io/badge/progress-100%25-green.svg) - [#11](https://github.com/webpack/webpack.io/issues/11)
+
 ## Git Flow
 
 We are using the [git flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model. Please direct all pull requests for code changes to the [develop](https://github.com/webpack/webpack.io/tree/develop) branch. [Content](https://github.com/webpack/webpack.io/tree/master/src/content) changes are fine on to make on master.