CONTRIBUTING.md

May 13, 2019 ยท View on GitHub

Contribution Guidelines

Contributor Agreement

To contribute source code to this repository, please read our Contributor Agreement, and then execute it by running this notebook and following the instructions.

Setting-up this project locally

Requirements

  • Scala 2.12.2
  • sbt 1.2.8

Generate artifacts

To generate JavaScript artifact (generated at ./js/module/webapi-parser.js), run:

sbt webapiJS/fullOptJS && ./scripts/buildjs.sh

To generate regular (not "fat") .jar, run:

sbt package

To generate a "fat" .jar (generated at ./webapi-parser-X.Y.Z.jar), run:

sbt assembleFatJar

and then you can copy/move that JAR to your libs directory and depend on it directly:

dependencies {
    compile files('libs/webapi-parser-X.Y.Z.jar')
}

Running tests

sbt test