Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests Start by opening an issue for your change on the Spark Project JIRA (and make sure to search whether there's an existing issue), then after you've developed your work, send a pull request against the github.com/apache/spark repository. If you've previously forked Spark from its old location, you will need to fork apache/spark instead..

Please follow the steps below Here are a few tips to get your contribution in:

  1. 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.
  2. Create an issue for your patch on the Spark Project JIRA.
  3. If you are proposing a large larger change, attach a design document to your JIRA first (example) and email the dev mailing list to discuss it.
  4. Submit the patch as a GitHub pull request. For a tutorial, see the GitHub guides on forking a repo and sending a pull request. Name your pull request with the JIRA name and include the Spark module or WIP if relevant.

  5. Follow the Spark Code Style Guide. Before sending in your pull request, you can run ./dev/lint-scala and ./dev/lint-python to validate the style.
  6. Make sure that your code passes the automated tests (see the Automated Testing sectionbelow)
  7. 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.
  8. Update the documentation (in the docs folder) if you add a new feature or configuration parameter.

...