Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (55 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 2.12 KB

Contributing

General recommendations

Test and document each added feature.

Organization of the repository

  • sbt-scalajs-bundler/ The scalajs-bundler sbt plugin
  • sbt-web-scalajs-bundler/ sbt plugin for integrating scalajs-bundler and sbt-web-scalajs
  • manual/ Sources of the documentation

Build the project

$ sbt package

Run the tests

We use sbt-scripted to test the plugins. However, we customized the way tests are launched to filter tests according to their compatibility with major versions of sbt and Scala.js:

  • tests can have a project/build.properties file defining a specific sbt version they are compatible with,

To run all the tests:

$ sbt scripted

To run a single test:

$ sbt "sbt-scalajs-bundler/scripted sbt-scalajs-bundler/<test-name>"

(where <test-name> is replaced by one of the tests).

Sometimes you would like to open an interactive sbt shell and manually play with sbt tasks instead of writing them into a sbt-scripted test. In such a case, you can start with an existing sbt-scripted test and add the following commands at the top of its test file:

$ pause
$ fail

Then, when you will run the scripted task on this this test, it will start by making a pause. You can then open a new sbt shell in the running test:

$ cd /tmp/sbt_fa1e13d43/test-name
$ sbt -Dplugin.version=x.y.z-SNAPSHOT

(where x.y.z is replaced by the current version of sbt-scalajs-bundler)

Publish locally

$ sbt publishLocal

Preview the documentation

$ sbt manual/previewSite

Publish a release

  • Check that the changelog.md file is up to date (in the manual project)
  • Push a Git tag (name it vX.Y.Z, where X, Y, Z are major, minor and revision numbers, respectively)
    • Either from GitHub web interface,
    • Or from the Git CLI: $ git tag v1.0.0; git push --tags