Skip to main content

Contribution

All suggestions welcome​

See the list of issues on GitHub and pick one! Or report your own.

If you are having doubts on why or how something works, don't hesitate to ask a question via GitHub Issues.
This probably means that the documentation, ScalaDocs or code is unclear and could be improved for the benefit of all.

Testing locally​

Tests don't require any environment installed, so simply run:

sbt test

Note: most important tests are integration-tests, so pay close attention when updating them.

Building the site locally​

  1. Start the site in watch mode:
make start-site
  1. In case of documentation changes, re-generate the documentation:
make gen-doc

The watcher should pick up your changes

Working on Documentation​

If you are editing the documentation (not the API Scaladocs) and you want to see the results as you work, you can:

  1. Run npm run start from the /website directory, which will start the Docusaurus server (port 3000), and leave it running.
  2. Run sbt mdoc from the root / directory, which will copy your changes from the src directory (where you are working) to the target directory (where Docusaurus can see the changes to update the browser window).