diff options
| author | Andy Konwinski <andrew@apache.org> | 2013-08-23 17:44:20 +0000 |
|---|---|---|
| committer | Andy Konwinski <andrew@apache.org> | 2013-08-23 17:44:20 +0000 |
| commit | 9a551ef906b9de00416b35b03253ff970557c25a (patch) | |
| tree | 219b236eacfe9cb6ccb9afb021f3a2b1671b2723 /site/docs/0.6.1/contributing-to-spark.html | |
| parent | 57c18920c3eddd8bc94cd05419e11d652e67d9c3 (diff) | |
| download | spark-website-9a551ef906b9de00416b35b03253ff970557c25a.tar.gz spark-website-9a551ef906b9de00416b35b03253ff970557c25a.tar.bz2 spark-website-9a551ef906b9de00416b35b03253ff970557c25a.zip | |
add docs dir.
Diffstat (limited to 'site/docs/0.6.1/contributing-to-spark.html')
| -rw-r--r-- | site/docs/0.6.1/contributing-to-spark.html | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/site/docs/0.6.1/contributing-to-spark.html b/site/docs/0.6.1/contributing-to-spark.html new file mode 100644 index 000000000..2577e9777 --- /dev/null +++ b/site/docs/0.6.1/contributing-to-spark.html @@ -0,0 +1,179 @@ +<!DOCTYPE html> +<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]--> +<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]--> +<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]--> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + <title>Contributing to Spark - Spark 0.6.1 Documentation</title> + <meta name="description" content=""> + + <link rel="stylesheet" href="css/bootstrap.min.css"> + <style> + body { + padding-top: 60px; + padding-bottom: 40px; + } + </style> + <meta name="viewport" content="width=device-width"> + <link rel="stylesheet" href="css/bootstrap-responsive.min.css"> + <link rel="stylesheet" href="css/main.css"> + + <script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script> + + <link rel="stylesheet" href="css/pygments-default.css"> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-32518208-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body> + <!--[if lt IE 7]> + <p class="chromeframe">You are using an outdated browser. <a href="http://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p> + <![endif]--> + + <!-- This code is taken from http://twitter.github.com/bootstrap/examples/hero.html --> + + <div class="navbar navbar-fixed-top" id="topbar"> + <div class="navbar-inner"> + <div class="container"> + <div class="brand"><a href="index.html"> + <img src="img/spark-logo-77x50px-hd.png" /></a><span class="version">0.6.1</span> + </div> + <ul class="nav"> + <!--TODO(andyk): Add class="active" attribute to li some how.--> + <li><a href="index.html">Overview</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guides<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="quick-start.html">Quick Start</a></li> + <li><a href="scala-programming-guide.html">Scala</a></li> + <li><a href="java-programming-guide.html">Java</a></li> + </ul> + </li> + + <li><a href="api/core/index.html">API (Scaladoc)</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="ec2-scripts.html">Amazon EC2</a></li> + <li><a href="spark-standalone.html">Standalone Mode</a></li> + <li><a href="running-on-mesos.html">Mesos</a></li> + <li><a href="running-on-yarn.html">YARN</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="api.html" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="configuration.html">Configuration</a></li> + <li><a href="tuning.html">Tuning Guide</a></li> + <li><a href="bagel-programming-guide.html">Bagel (Pregel on Spark)</a></li> + <li><a href="contributing-to-spark.html">Contributing to Spark</a></li> + </ul> + </li> + </ul> + <!--<p class="navbar-text pull-right"><span class="version-text">v0.6.1</span></p>--> + </div> + </div> + </div> + + <div class="container" id="content"> + <h1 class="title">Contributing to Spark</h1> + + <p>The Spark team welcomes contributions in the form of GitHub pull requests. Here are a few tips to get your contribution in:</p> + +<ul> + <li>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.</li> + <li>Submit the patch as a GitHub pull request. For a tutorial, see the GitHub guides on <a href="https://help.github.com/articles/fork-a-repo">forking a repo</a> and <a href="https://help.github.com/articles/using-pull-requests">sending a pull request</a>.</li> + <li>Follow the style of the existing codebase. Specifically, we use <a href="http://docs.scala-lang.org/style/">standard Scala style guide</a>, but with the following changes: + <ul> + <li>Maximum line length of 100 characters.</li> + <li>Always import packages using absolute paths (e.g. <code>scala.collection.Map</code> instead of <code>collection.Map</code>).</li> + <li>No “infix” syntax for methods other than operators. For example, don’t write <code>table containsKey myKey</code>; replace it with <code>table.containsKey(myKey)</code>.</li> + </ul> + </li> + <li>Make sure that your code passes the unit tests. You can run the tests with <code>sbt/sbt test</code> in the root directory of Spark. +But first, make sure that you have <a href="configuration.html">configured a spark-env.sh</a> with at least +<code>SCALA_HOME</code>, as some of the tests try to spawn subprocesses using this.</li> + <li>Add new unit tests for your code. We use <a href="http://www.scalatest.org/">ScalaTest</a> for testing. Just add a new Suite in <code>core/src/test</code>, or methods to an existing Suite.</li> + <li>If you’d like to report a bug but don’t have time to fix it, you can still post it to our <a href="https://spark-project.atlassian.net">issues page</a>, or email the <a href="http://www.spark-project.org/mailing-lists.html">mailing list</a>.</li> +</ul> + +<h1 id="licensing-of-contributions">Licensing of Contributions</h1> + +<p>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. <em>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.</em></p> + + <!-- Main hero unit for a primary marketing message or call to action --> + <!--<div class="hero-unit"> + <h1>Hello, world!</h1> + <p>This is a template for a simple marketing or informational website. It includes a large callout called the hero unit and three supporting pieces of content. Use it as a starting point to create something more unique.</p> + <p><a class="btn btn-primary btn-large">Learn more »</a></p> + </div>--> + + <!-- Example row of columns --> + <!--<div class="row"> + <div class="span4"> + <h2>Heading</h2> + <p>Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. </p> + <p><a class="btn" href="#">View details »</a></p> + </div> + <div class="span4"> + <h2>Heading</h2> + <p>Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. </p> + <p><a class="btn" href="#">View details »</a></p> + </div> + <div class="span4"> + <h2>Heading</h2> + <p>Donec sed odio dui. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Vestibulum id ligula porta felis euismod semper. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</p> + <p><a class="btn" href="#">View details »</a></p> + </div> + </div> + + <hr>--> + + <!--<footer> + <p></p> + </footer>--> + + </div> <!-- /container --> + + <script src="js/vendor/jquery-1.8.0.min.js"></script> + <script src="js/vendor/bootstrap.min.js"></script> + <script src="js/main.js"></script> + + <!-- A script to fix internal hash links because we have an overlapping top bar. + Based on https://github.com/twitter/bootstrap/issues/193#issuecomment-2281510 --> + <script> + $(function() { + function maybeScrollToHash() { + if (window.location.hash && $(window.location.hash).length) { + var newTop = $(window.location.hash).offset().top - $('#topbar').height() - 5; + $(window).scrollTop(newTop); + } + } + $(window).bind('hashchange', function() { + maybeScrollToHash(); + }); + // Scroll now too in case we had opened the page on a hash, but wait 1 ms because some browsers + // will try to do *their* initial scroll after running the onReady handler. + setTimeout(function() { maybeScrollToHash(); }, 1) + }) + </script> + + </body> +</html> |