docs(update): Add contributing and update readme

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing Guidelines
+
+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 first
+* Develop in a topic branch, not master
+* Squash your commits
+
+### Linting
+
+Please check your code using `npm run lint` before submitting your pull requests, as the CI build will fail if `eslint` fails.
+
+### 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:
+
+```
+ #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

README.md

@@ -4,14 +4,17 @@ The project is based on [`react-redux-starter-kit`](https://github.com/davezuko/
 The main idea is to offer to the Phoenix developer one of the best react redux starter kit I ever seen before.
 A large part of the content of this README file could be the same than which on the [`react-redux-starter-kit`](https://github.com/davezuko/react-redux-starter-kit) page.
 
+Actualy the project is devided in several branches : master, language-support, ecto, user_support, user-support-multilanguage
+
 ## Table of content
 
 1. Features
 2. Requirements
-3. Start
-4. Deployment
-5. Learn more
-6. Inspiraction
+3. Branches
+4. Start
+5. Deployment
+6. Learn more
+7. Inspiraction
 
 ## Features
 
@@ -30,13 +33,23 @@ A large part of the content of this README file could be the same than which on
 - node
 - npm
 
+## Branches
+
+Like there are serveral way to start a project, I added some nice feature in sub-branches to help developpers to start faster there projects. May be in a futur I will move thoses branches in independant github project :
+
+- master : is a starter kit without Ecto support
+  - language-support : include a multilanguage support using `react-intl`
+  - ecto : include `ecto` deps with `postgrex`
+    - user_support : include a small user support. Add a `restricted area`, a user `create`, `login` and `logout`. It also add `Websocket user connection`
+      - user-support-multilanguage : merge `user_support` with `language-support`
+
 ## Start
 
 To start your Phoenix app:
 
-  * Install dependencies with `mix deps.get`
-  * Install node modules with `npm install` 
-  * Start Phoenix endpoint with `mix phoenix.server`
+* Install dependencies with `mix deps.get`
+* Install node modules with `npm install` 
+    * Start Phoenix endpoint with `mix phoenix.server`
 
 Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
 
@@ -78,11 +91,11 @@ Ready to run in production? Please [check our deployment guides](http://www.phoe
 
 ## Learn more
 
-  * Official website: http://www.phoenixframework.org/
-  * Guides: http://phoenixframework.org/docs/overview
-  * Docs: https://hexdocs.pm/phoenix
-  * Mailing list: http://groups.google.com/group/phoenix-talk
-  * Source: https://github.com/phoenixframework/phoenix
+* Official website: http://www.phoenixframework.org/
+* Guides: http://phoenixframework.org/docs/overview
+    * Docs: https://hexdocs.pm/phoenix
+    * Mailing list: http://groups.google.com/group/phoenix-talk
+    * Source: https://github.com/phoenixframework/phoenix
 
 ## Inspiraction
 - [https://github.com/terakilobyte/phoenix-elixir-react-redux-starter-kit](https://github.com/terakilobyte/phoenix-elixir-react-redux-starter-kit)