Skip to content

Update contrib #861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update contrib #861

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f34b5ce
Update CONTRIBUTING.md
Quafadas Oct 1, 2024
fdf0347
Update CONTRIBUTING.md
Quafadas Oct 1, 2024
7b5364b
More colour on coursier
Quafadas Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ Contents:
* Binary Compatibility
* Submitting a PR

Getting started
=======
Scala js dom currently targets java 17 for maximum compatibility. If your shell is targeting a JVM higher than 17, you may experience confusing error messages when starting SBT.

[Coursier](https://get-coursier.io/) is the de facto standard for artefact fetching in scala. Using coursier it is possible to launch SBT with a specific JVM version. The default [installation](https://get-coursier.io/docs/cli-installation) of coursier will put `cs` on your path, after which the following command (run in the root of the project)

```sh
cs launch sbt --jvm 17
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a coursier-less way to do this? I don't think we should include it if it is not possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm... not that I know of, although there are many things I don't know :-). I would note, that that I bled some time figuring out the JVM 17 requirement, and then plenty of time futzing with env variables in shells before hitting on this as a QuickStart.

I'm not precious on it, so will bow to superior wisdom - it would have helped me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not precious on it, so will bow to superior wisdom - it would have helped me.

I understand that it helps local dev, so how about a small paragraph explaining what cs is with a link to the coursier site?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds quite reasonable... BRB.

```
will (if necessary download and) start sbt with temurin 17 - i.e. a jvm known to be compatible with the project.

Packages
========
Expand Down
Loading