spark/docs/contributing-to-spark.md

---
layout: global
title: Contributing to Spark
---

The Spark team welcomes contributions in the form of GitHub pull requests. Here are a few tips to get your contribution in:

- Break your work into small, single-purpose patches if possible. It's much harder to merge in a large change with a lot of disjoint features.
- Submit the patch as a GitHub pull request. For a tutorial, see the GitHub guides on [forking a repo](https://help.github.com/articles/fork-a-repo) and [sending a pull request](https://help.github.com/articles/using-pull-requests).
- Follow the style of the existing codebase. Specifically, we use [standard Scala style guide](http://docs.scala-lang.org/style/), but with the following changes:
  * 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.
- 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

Contributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please
state that the contribution is your original work and that you license the work to the project under the project's open source 
license. *Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other 
means you agree to license the material under the project's open source license and warrant that you have the legal authority 
to do so.*
Adding docs directory containing documentation currently on the wiki which can be compiled via jekyll, using the command `jekyll`. To compile and run a local webserver to serve the doc as a website, run `jekyll --server`. 2012-09-03 10:05:40 +04:00			`---`
			`layout: global`
Small tweaks to generated doc pages 2012-09-13 06:47:31 +04:00			`title: Contributing to Spark`
Adding docs directory containing documentation currently on the wiki which can be compiled via jekyll, using the command `jekyll`. To compile and run a local webserver to serve the doc as a website, run `jekyll --server`. 2012-09-03 10:05:40 +04:00			`---`

Fixing lots of broken links. 2012-09-13 03:05:19 +04:00			`The Spark team welcomes contributions in the form of GitHub pull requests. Here are a few tips to get your contribution in:`
Adding docs directory containing documentation currently on the wiki which can be compiled via jekyll, using the command `jekyll`. To compile and run a local webserver to serve the doc as a website, run `jekyll --server`. 2012-09-03 10:05:40 +04:00
Fixing lots of broken links. 2012-09-13 03:05:19 +04:00			`- Break your work into small, single-purpose patches if possible. It's much harder to merge in a large change with a lot of disjoint features.`
			`- Submit the patch as a GitHub pull request. For a tutorial, see the GitHub guides on [forking a repo](https://help.github.com/articles/fork-a-repo) and [sending a pull request](https://help.github.com/articles/using-pull-requests).`
			`- Follow the style of the existing codebase. Specifically, we use [standard Scala style guide](http://docs.scala-lang.org/style/), but with the following changes:`
Adding docs directory containing documentation currently on the wiki which can be compiled via jekyll, using the command `jekyll`. To compile and run a local webserver to serve the doc as a website, run `jekyll --server`. 2012-09-03 10:05:40 +04:00			`* Maximum line length of 100 characters.`
			* Always import packages using absolute paths (e.g. `scala.collection.Map` instead of `collection.Map`).
Fixing lots of broken links. 2012-09-13 03:05:19 +04:00			* 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.
More updates to documentation 2012-09-26 06:31:07 +04:00			`- 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).`
Adding docs directory containing documentation currently on the wiki which can be compiled via jekyll, using the command `jekyll`. To compile and run a local webserver to serve the doc as a website, run `jekyll --server`. 2012-09-03 10:05:40 +04:00
More updates to documentation 2012-09-26 06:31:07 +04:00			`# Licensing of Contributions`

			`Contributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please`
			`state that the contribution is your original work and that you license the work to the project under the project's open source`
			`license. *Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other`
			`means you agree to license the material under the project's open source license and warrant that you have the legal authority`
			`to do so.*`