typelevel / typelevel/cats-effect

Be more reassuring about cross-platform semantics

Open
#2,928 3 comments 1 reaction 1 assignee View on GitHub

@armanbilge is already working on this.

Since Apr 1, 2022.

:books: docs
Dominant language
Scala
Stars
2.2k
Forks
576
Avg merge
2d 11h
Merged PRs (30d)
18

Description

(My summary/analysis of this Discord discussion.)

After we've worked so hard to preserve cross-platform semantics, at least I have forgotten that apparently this is surprising for users. When the expectation is that Scala.js support is second-class, users may doubt whether certain things work or various advice applies and look to docs/support to answer their questions.

So, we probably need to be more reassuring and upfront about the fact that everything pretty much works the same. I think for the most part, that unless otherwise noted, basically all the docs apply to both JVM and JS.

I have a bit of this in my feral README.
https://github.com/typelevel/feral#why-go-feral

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.