CONTRIBUTING.md

Contributing to skan

Thanks for being willing to contribute!

skan is written in Scala and built with scala-cli. You'll find a Makefile at the root of this project that will have most of the commands that you'll actually need to work on skan.

Prerequisites

• Make sure scala-cli is installed on your machine.

Common Tasks

Setting up for your editor

Most commonly for Scala people will use either IntelliJ or Metals. You're free to use what you'd like but before using either, you'll want to run the following:

make setup-ide

After doing this you can open up your project and get to work.

Compiling your project

To compile skan you'll run the following:

make compile

To run the tests

The tests are fast enough that you shouldn't have to worry about only running a subset of them. So the easiest way to run them is:

make test

To run the project

To test that everything is working as expected you can run your current code with:

make run

Formatting the sources

To format everything with scalafmt you'll run the following:

make format

Building a native image

make package

If this works you should get a out/skan created that you can execute with ./out/skan to test.

Helpful links

• tui-scala which is the main library used for skan.