You will need the following tools:
Create your own fork of the repository and work in a local branch based on master
.
We use scalafmt to format the source code, and recommend you to setup your editor to “format on save”, as documented here.
From the sbt shell:
+test
From the sbt shell:
documentation/previewSite
It will open the generated documentation in your browser.
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.