KSH-code
diff --git a/‎CONTRIBUTING.rst‎ ‎CONTRIBUTING.md‎CONTRIBUTING.rst renamed to CONTRIBUTING.md
Lines changed: 48 additions & 20 deletions b/‎CONTRIBUTING.rst‎ ‎CONTRIBUTING.md‎CONTRIBUTING.rst renamed to CONTRIBUTING.md
Lines changed: 48 additions & 20 deletions
diff --git a/‎README.md‎
Lines changed: 3 additions & 6 deletions b/‎README.md‎
Lines changed: 3 additions & 6 deletions
@@ -1,8 +1,6 @@
-Contributing guidelines
-=======================
+# Contributing guidelines
 
-Working on an issue
--------------------
+## Working on an issue
 
 Before starting to work on something, please comment in JIRA or ask on the mailing list
 to make sure nobody else is working on it.
@@ -13,44 +11,41 @@ get merged in 2.1.
 Before you send your pull request, make sure that:
 
 - you have a unit test that failed before the fix and succeeds after.
-- the fix is mentioned in ``driver-core/CHANGELOG.rst``.
+- the fix is mentioned in `driver-core/CHANGELOG.rst`.
 - the commit message include the reference of the JIRA ticket for automatic linking
-  (example: ``Fix NPE when a connection fails during pool construction (JAVA-503).``).
+  (example: `Fix NPE when a connection fails during pool construction (JAVA-503).`).
 
 As long as your pull request is not merged, it's OK to rebase your branch and push with
-``--force``.
+`--force`.
 
-If you want to contribute but don't have a specific issue in mind, the `lhf <https://datastax-oss.atlassian.net/secure/IssueNavigator.jspa?reset=true&mode=hide&jqlQuery=project%20%3D%20JAVA%20AND%20status%20in%20(Open%2C%20Reopened)%20AND%20labels%20%3D%20lhf>`_
+If you want to contribute but don't have a specific issue in mind, the [lhf](https://datastax-oss.atlassian.net/secure/IssueNavigator.jspa?reset=true&mode=hide&jqlQuery=project%20%3D%20JAVA%20AND%20status%20in%20(Open%2C%20Reopened)%20AND%20labels%20%3D%20lhf)
 label in JIRA is a good place to start: it marks "low hanging fruits" that don't require
 in-depth knowledge of the codebase.
 
-Editor configuration
---------------------
+## Editor configuration
 
-General
-~~~~~~~
+### General
 
 We consider automatic formatting as a help, not a crutch. Sometimes it makes sense to
 break the rules to make the code more readable, for instance aligning columns (see the
-constant declarations in ``DataType.Name`` for an example of this).
+constant declarations in `DataType.Name` for an example of this).
 
 **Please do not reformat whole files, only the lines that you have added or modified**.
 
 
-Eclipse
-~~~~~~~
+### Eclipse
 
 Formatter:
 
 - Preferences > Java > Code Style > Formatter.
 - Click "Import".
-- Select ``src/main/config/ide/eclipse-formatter.xml``.
+- Select `src/main/config/ide/eclipse-formatter.xml`.
 
 Import order:
 
 - Preferences > Java > Code Style > Organize imports.
 - Click "Import".
-- Select ``src/main/config/ide/eclipse.importorder``.
+- Select `src/main/config/ide/eclipse.importorder`.
 
 Prevent trailing whitespaces:
 
@@ -63,10 +58,43 @@ Prevent trailing whitespaces:
 - Click "OK" (the text area should only have one action "Remove trailing white spaces").
 
 
-IntelliJ IDEA
-~~~~~~~~~~~~~
+### IntelliJ IDEA
 
 - File > Import Settings...
-- Select ``src/main/config/ide/intellij-code-style.jar``.
+- Select `src/main/config/ide/intellij-code-style.jar`.
 
 This should add a new Code Style scheme called "java-driver".
+
+## Running the tests
+
+We use TestNG. There are 3 test categories:
+
+- "unit": pure Java unit tests.
+- "short" and "long": integration tests that launch Cassandra instances.
+
+The Maven build uses profiles named after the categories to choose which tests to run:
+
+```
+mvn test -Pshort
+```
+
+The default is "unit". Each profile runs the ones before it ("short" runs unit, etc.)
+
+Integration tests use [CCM](https://github.com/pcmanus/ccm) to bootstrap Cassandra instances.
+Two Maven properties control its execution:
+
+- `cassandra.version`: the Cassandra version. This has a default value in the root POM,
+  you can override it on the command line (`-Dcassandra.version=...`).
+- `ipprefix`: the prefix of the IP addresses that the Cassandra instances will bind to (see
+  below). This defaults to `127.0.1.`.
+
+
+CCM launches multiple Cassandra instances on localhost by binding to different addresses. The
+driver uses up to 6 different instances (127.0.1.1 to 127.0.1.6 with the default prefix).
+You'll need to define loopback aliases for this to work, on Mac OS X your can do it with:
+
+```
+sudo ifconfig lo0 alias 127.0.1.1 up
+sudo ifconfig lo0 alias 127.0.1.2 up
+...
+```
@@ -61,7 +61,7 @@ Please refer to the README of each module for more information.
 - TWITTER: Follow the latest news about DataStax Drivers - [@olim7t](http://twitter.com/olim7t), [@mfiguiere](http://twitter.com/mfiguiere)
 - DOCS: http://www.datastax.com/documentation/developer/java-driver/2.1/index.html
 - API: http://www.datastax.com/drivers/java/2.1
-- CHANGELOG: https://github.com/datastax/java-driver/blob/2.1/driver-core/CHANGELOG.rst
+
 
 ## Maven
 
@@ -106,11 +106,8 @@ an [UnsupportedFeatureException](https://github.com/datastax/java-driver/blob/2.
 
 ## Upgrading from previous versions
 
-If you are upgrading from the 2.0.x branch of the driver, be sure to have a look at
-the [upgrade guide](https://github.com/datastax/java-driver/blob/2.1/driver-core/Upgrade_guide_to_2.1.rst).
-
-If you are upgrading from the 1.x branch, follow the [upgrade guide to 2.0](https://github.com/datastax/java-driver/blob/2.0/driver-core/Upgrade_guide_to_2.0.rst),
-and then the above document.
+If you are upgrading from a previous version of the driver, be sure to have a look at
+the [upgrade guide](/upgrade_guide/).
 
 
 ### Troubleshooting