Add details on how to contribute

Author: AutomatedTester

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# How to Contribute
+
+Firstly, thanks for wanting to contribute back to this project. Below are
+guidelines that should hopefully minimise the amount of backwards and forwards
+in the review process.
+
+## Getting Started
+
+* Fork the repository on GitHub - well... duh :P
+* Create a virtualenv: `virtualenv venv`
+* Activate the virtualenv: `. venv/bin/activate`
+* Install the package in develop mode: `python setup.py develop`
+* Install requirements: `pip install -r requirements.txt`
+* Run the tests to check that everything was successful: `py.test tests`
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target release branches if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on master; `git checkout -b
+    /my_contribution master`. Please avoid working directly on the
+    `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the main repository
+* After feedback has been given we expect responses within two weeks. After two
+  weeks will may close the pull request if it isn't showing any activity.

docs/index.rst

@@ -5,12 +5,13 @@
 .. highlightlang:: python
 
 
-
+============================================
 Welcome to BrowserMob Proxy's documentation!
 ============================================
 
 Python client for the BrowserMob Proxy 2.0 REST API.
 
+--------------
 How to install
 --------------
 
@@ -30,6 +31,7 @@ Then install it by running::
 
     $ python setup.py install
 
+----------------------------------
 How to use with selenium-webdriver
 ----------------------------------
 
@@ -53,6 +55,43 @@ Manually::
     server.stop()
     driver.quit()
 
+-----------------
+How to Contribute
+-----------------
+
+Getting Started
+---------------
+
+* Fork the repository on GitHub - well... duh :P
+* Create a virtualenv: `virtualenv venv`
+* Activate the virtualenv: `. venv/bin/activate`
+* Install the package in develop mode: `python setup.py develop`
+* Install requirements: `pip install -r requirements.txt`
+* Run the tests to check that everything was successful: `py.test tests
+
+Making Changes
+--------------
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target release branches if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on master; `git checkout -b
+    /my_contribution master`. Please avoid working directly on the
+    `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+Submitting Changes
+------------------
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the main repository
+* After feedback has been given we expect responses within two weeks. After two
+  weeks will may close the pull request if it isn't showing any activity
+
 Contents:
 
 .. toctree::