aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing-to-spark.md
diff options
context:
space:
mode:
authorMatei Zaharia <matei@eecs.berkeley.edu>2012-09-26 23:22:15 -0700
committerMatei Zaharia <matei@eecs.berkeley.edu>2012-09-26 23:22:15 -0700
commita4093f75637910524f501d36b268584006455d9b (patch)
tree158b145b7769e8fedb28d699351a32ffb6b59219 /docs/contributing-to-spark.md
parentea05fc130b64ce356ab7524a3d5bd1e022cf51b5 (diff)
downloadspark-a4093f75637910524f501d36b268584006455d9b.tar.gz
spark-a4093f75637910524f501d36b268584006455d9b.tar.bz2
spark-a4093f75637910524f501d36b268584006455d9b.zip
Minor doc fixes
Diffstat (limited to 'docs/contributing-to-spark.md')
-rw-r--r--docs/contributing-to-spark.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/contributing-to-spark.md b/docs/contributing-to-spark.md
index fa81b858eb..a0e645d6cc 100644
--- a/docs/contributing-to-spark.md
+++ b/docs/contributing-to-spark.md
@@ -11,7 +11,10 @@ The Spark team welcomes contributions in the form of GitHub pull requests. Here
* Maximum line length of 100 characters.
* Always import packages using absolute paths (e.g. `scala.collection.Map` instead of `collection.Map`).
* No "infix" syntax for methods other than operators. For example, don't write `table containsKey myKey`; replace it with `table.containsKey(myKey)`.
-- Add unit tests to your new code. We use [ScalaTest](http://www.scalatest.org/) for testing. Just add a new Suite in `core/src/test`, or methods to an existing Suite.
+- Make sure that your code passes the unit tests. You can run the tests with `sbt/sbt test` in the root directory of Spark.
+ But first, make sure that you have [configured a spark-env.sh]({{HOME_PATH}}configuration.html) with at least
+ `SCALA_HOME`, as some of the tests try to spawn subprocesses using this.
+- Add new unit tests for your code. We use [ScalaTest](http://www.scalatest.org/) for testing. Just add a new Suite in `core/src/test`, or methods to an existing Suite.
- If you'd like to report a bug but don't have time to fix it, you can still post it to our [issues page](https://github.com/mesos/spark/issues), or email the [mailing list](http://www.spark-project.org/mailing-lists.html).
# Licensing of Contributions