typelevel / typelevel/cats-effect
Add more recipes
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Follow-up to https://github.com/typelevel/cats-effect/issues/3410 / https://github.com/typelevel/cats-effect/pull/3412, which introduced the Recipes page:
https://typelevel.org/cats-effect/docs/recipes
"Recipes" are small examples that show how to solve common problems using Cats Effect. A "reverse-index" to the CE standard library, if you like. So ideally the recipes page will cover all of std.
Recipe ideas
- "how to atomically update a ref with the result of an effect" aka
AtomicCell - "how to handle multiple callbacks from some unsafe API" aka
Dispatcher(+Queue) - "how to guarantee exclusive access to some resource" aka
Mutex - "how to replace
KleisliwithIOLocal" - your ideas here 😁
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Recipes page at https://typelevel.org/cats-effect/docs/recipes and review the linked issue and pull request for its conventions. Choose one of the unchecked ideas, such as Dispatcher with Queue or Mutex, and add a small example that explains the common problem and its Cats Effect solution; done means the recipe is included on the page and follows the existing format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100