# Contributing to RasterFrames

Community contributions are always welcome. To get started, please review this document, 
the [code of conduct](https://github.com/locationtech/rasterframes/blob/develop/CODE_OF_CONDUCT.md), and reach out to 
us on [gitter](https://gitter.im/locationtech/rasterframes) so the community can help you get started!

The official home of RasterFrames under the Eclipse Foundation may be found here:

 * https://projects.eclipse.org/projects/locationtech.rasterframes
 
## Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must
electronically sign the Eclipse Contributor Agreement (ECA).

 * http://www.eclipse.org/legal/ECA.php

Commits that are provided by non-committers must have a Signed-off-by field in
the footer indicating that the author is aware of the terms by which the
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

## Developer Resources

The RasterFrames source code is hosted on GitHub:

 * https://github.com/locationtech/rasterframes
 
Issues should be submitted via GitHub issues:

 * https://github.com/locationtech/rasterframes/issues
 
A user manual may be found here:
 
 * http://rasterframes.io
 
## Building

RasterFrames uses [sbt](https://www.scala-sbt.org/) as its build tool. Standard build
commands are as follows:

* Compile: `sbt compile`
* Install packages locally: `sbt publishLocal`
* Run tests: `sbt test`
* Build documentation: `sbt makeSite`
* Spark shell with RasterFrames initialized: `sbt console`

## Contact

Help, questions and community dialog are supported via Gitter:

 * https://gitter.im/locationtech/rasterframes

Commercial support is available by writing to info@astraea.earth