THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
The
...
Apache
...
Spark
...
team
...
welcomes
...
all
...
types
...
of
...
contributions,
...
whether
...
they
...
be
...
bug
...
reports,
...
documentation,
...
or
...
new
...
patches.
...
Reporting
...
Issues
...
If
...
you'd
...
like
...
to
...
report
...
a
...
bug
...
in
...
Spark
...
or
...
ask
...
for
...
a
...
new
...
feature,
...
open
...
an
...
issue
...
on
...
the
...
...
...
...
.
...
For
...
general
...
usage
...
help,
...
you
...
should
...
...
the
...
...
...
...
.
Contributing Code
We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the github.com/apache/incubator-spark
...
repository.
...
If
...
you've
...
previously
...
forked
...
Spark
...
from
...
its
...
old
...
location,
...
you
...
will
...
need
...
to
...
fork
...
incubator-spark
...
instead.
...
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
...
...
...
...
- and
...
...
...
...
- request.
- Follow the Spark code style guide.
- Make sure that your code passes the unit tests. You can run the tests with
sbt/sbt assemblyand thensbt/sbt testin the root directory of Spark. It's important to runassemblyfirst as some of the tests depend on compiled JARs. - Add new unit tests for your code. We use ScalaTest for testing. Just add a new Suite in
core/src/test, or methods to an existing Suite. - Update the documentation (in the
docsfolder) if you add a new feature or configuration parameter.
If you’d like to report a bug but don’t have time to fix it, you can still post it to our issue tracker, or email the mailing list.
Documentation
If you'd like to contribute documentation, there are two ways:
- To have us add a link to an external tutorial you wrote, simply email the developer mailing list.
- To modify the built-in documentation, edit the MarkDown source files in Spark's
docsdirectory, and send a patch against the incubator-spark GitHub repository. The README file indocssays how to build the documentation locally to test your changes.
Development Discussions
To keep up to date with the latest discussions, join the developer mailing list.
IDE Setup
While many of the Spark developers use SBT or Maven on the command line, the most common IDE we use is IntelliJ IDEA. You can get the community edition for free and install the JetBrains Scala plugin from Preferences > Plugins. To generate an IDEA workspace for Spark, run
| Code Block |
|---|
|https://help.github.com/articles/using-pull-requests]. # Follow the [Spark code style guide]. # Make sure that your code passes the unit tests. You can run the tests with {{sbt/sbt assembly}} and then {{sbt/sbt test}} in the root directory of Spark. It's important to run {{assembly}} first as some of the tests depend on compiled JARs. # 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. # Update the documentation (in the {{docs}} folder) if you add a new feature or configuration parameter. If you’d like to report a bug but don’t have time to fix it, you can still post it to our issue tracker, or email the mailing list. h3. Documentation If you'd like to contribute documentation, there are two ways: * To have us add a link to an external tutorial you wrote, simply email the [developer mailing list|http://spark.incubator.apache.org/mailing-lists.html]. * To modify the [built-in documentation|http://spark.incubator.apache.org/docs/latest], edit the MarkDown source files in Spark's {{docs}} directory, and send a patch against the [incubator-spark|https://github.com/apache/incubator-spark] GitHub repository. The README file in {{docs}} says how to build the documentation locally to test your changes. h3. Development Discussions To keep up to date with the latest discussions, join the [developer mailing list|http://spark.incubator.apache.org/mailing-lists.html]. h3. IDE Setup While many of the Spark developers use SBT or Maven on the command line, the most common IDE we use is IntelliJ IDEA. You can get the [community edition|http://www.jetbrains.com/idea/free_java_ide.html] for free and install the [JetBrains Scala plugin|http://plugins.jetbrains.com/plugin/?id=1347] from Preferences > Plugins. To generate an IDEA workspace for Spark, run {code} sbt/sbt update gen-idea {/code} Then import the folder into IDEA. When you build the project, you might get a warning about "test and compile output paths" being the same for the |
Then import the folder into IDEA. When you build the project, you might get a warning about "test and compile output paths" being the same for the "root-build"
...
project.
...
You
...
can
...
fix
...
it
...
by
...
opening
...
File
...
->
...
Project
...
Structure
...
and
...
changing
...
the
...
output
...
path
...
of
...
the
...
root-build
...
module
...
to
...
be
...
<spark-home>/project/target/idea-test-classes
...
instead
...
of
...
idea-classes
...
.
...
If
...
you
...
use
...
Eclipse
...
to
...
develop
...
Spark,
...
feel
...
free
...
to
...
add
...
a
...
short
...
guide
...
on
...
setting
...
it
...
up
...
to
...
this
...
wiki
...
page.