You will need the following tools:
Create your own fork of the repository and work in a local branch based on main. Binary compatible
fixes should be based on the corresponding branch version (e.g., 1.x).
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
Push a Git tag:
$ git tag v2.0.0
$ git push origin v2.0.0After releasing a new major version, create a new Git branch (e.g., 2.x) that will contain the binary
compatible evolutions of that version. In this branch, set the mimaPreviousArtifacts setting (in file
build.sbt) to the following value:
-mimaPreviousArtifacts := Set.empty
+mimaPreviousArtifacts := previousStableVersion.value.map(organization.value %% name.value % _).toSet