Align API with cats/fs2
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 379
- Avg merge
- 14m
- Merged PRs (30d)
- 8
Description
There have been several API changes in cats, cats-effect and fs2. As we are still in milestone phase, it'd be helpful for newcomers to keep the names as consistent as possible with our dependencies.
Things to consider (maybe incomplete):
Update#fail->Update#raiseError(MonadError#raiseError)Update(0)#run->Update(0)#compile(Stream#compile): might be confusing becauseStream#compileneeds a consequent combinator unlike deprecatedStream#run- deprecate
Query(0)#processin favor ofQuery(0)#stream {Kernel, Composite}#zip->{Kernel, Composite}#product(Semigroupal#product) orKernel.product -> Kernel.zip
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 Update, Query, Kernel, and Composite entry points named in the issue, then compare their APIs with the linked cats and fs2 documentation. Done means the proposed names are aligned consistently, with the specified deprecation handled and any ambiguity around compile, product, and zip resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- api, database
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100