Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (39 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

52 lines (39 loc) · 1.28 KB

Contributing

Requirements

Workflow

  1. Create your fork of this repository
  2. Create a local branch based on master
  3. Work in the branch
  4. Push the branch into your repository
  5. Create a Pull Request to the master branch of this repository

Code Style

We use Scalafmt to format the source code.
We recommend you set up your editor as documented here.

Run Tests

sbt test

Run Integration Tests

sbt multi-jvm:test

If we want to dig in failed test cases in integration tests, we can look at integration test reports **/target/multi-jvm-test-reports/*.xml using xunit-viewer.

Tips: Integration tests is not stable for now.

Take test coverage

sbt testCoverage

A test coverage is generated in the directory target/scala-2.13/scoverage-report.

Build Scaladoc

sbt unidoc

Scaladoc is generated in the directory target/scala-2.13/unidoc.

Preview GitHub Pages

To preview generated GitHub Pages, run the below command.

sbt previewSite