Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1013 Bytes

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1013 Bytes

Contributing

Requirements

You will need the following tools:

Workflow

Create your own fork of the repository and work in a local branch based on master.

Code Style

We use scalafmt to format the source code, and recommend you to setup your editor to “format on save”, as documented here.

Run Tests

From the sbt shell:

+test

Preview Documentation

From the sbt shell:

documentation/previewSite

It will open the generated documentation in your browser.

Publish a Release

Push a Git tag:

$ git tag v2.0.0
$ git push origin v2.0.0

Then, reset the compatibility guarantees in build.sbt:

versionPolicyIntention := Compatibility.BinaryAndSourceCompatible

Commit and push the changes.