contributing.md

Contributing

Importing the build into IntelliJ

This codebase is primarily developed with VS Code but it's possible to work on this codebase with IntelliJ. There are a few quirks when importing the build into IntelliJ since MUnit is cross-compiled against multiple platforms (JVM, JavaScript and Native).

• Use "Open or import" and select the MUnit directory.

• If prompted to select import via sbt or bsp, select sbt.

  

• If you get a "No scalac found to compile scala sources" error, you may need to manually add Scala SDK 2.13.3 to the junit module.

  

• If you get a "Class not found" error when running tests, you may need to manually edit the run configuration to use the testsJVM module instead of tests-sources.

  

• There may be highlighting errors for PlatformCompat and BuildInfo. You can ignore these highlighting errors, the project should still compile successfully.

If everything is setup correctly, you should be able to run tests and debug via IntelliJ like normal:

Please ask on Gitter if you have any issues working on the MUnit codebase via IntelliJ.