Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

75 lines (53 loc) · 1.96 KB

Contributing to SETL

Thanks sooooo much for taking time to contribute 👍

Bug report

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Feature request

When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Development

Quick guide

  • Fork the project & clone locally.
  • Create an upstream remote and sync your local copy before you branch.
  • Branch for each separate piece of work.
  • Push to the origin repository (the fork).
  • Create a new Pull Request in GitHub.

Build

Use pre-created profiles to change version.

# Build SNAPSHOT with Scala 2.11
mvn clean package -Psnapshot -Pscala_2.11 -Pspark_2.4

# Build RELEASE with Scala 2.11
mvn clean package -Prelease -Pscala_2.11 -Pspark_2.4

# Build SNAPSHOT with Scala 2.12
./dev/change-scala-version.sh 2.12
mvn clean package -Psnapshot -Pscala_2.12 -Pspark_2.4

# Build RELEASE with Scala 2.12
./dev/change-scala-version.sh 2.12
mvn clean package -Prelease -Pscala_2.12 -Pspark_2.4

Unit tests

We use docker to provide services for the unit test. Run the following command before the unit test:

docker-compose -f ./dev/docker-compose.yml up

To start the test with cli:

export SCALA_VER=2.11
export SPARK_VER=2.4
./dev/test.sh

Note: in some case you get the following error

java.net.BindException: Can't assign requested address: Service 'sparkDriver'

then you have to bind the spark to local ip like this

export SPARK_LOCAL_IP=127.0.0.1

Styleguide

Commit styleguide

Please refer to Conventional Commits

Scala styleguide

Please refer to Databricks Scala Guide