typelevel / typelevel/cats-effect

Create a FAQ/best practices page

Open
#1,143 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

  • FAQ
  • best practices
  • idioms
  • common patterns

It's definitely worth doing this for CE3, but might be worthwhile doing for CE2 first

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.

Research direction

No file or test is identified. First resolve whether the page targets CE2 or CE3, then inspect the existing Cats Effect documentation for overlap; done means a reviewed page covering the requested FAQ, best practices, idioms, and common patterns for the selected version.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.