typelevel / typelevel/mouse

Proposal: Enhance navigation in the root `mouse` package

Open
#362 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

RFC
Dominant language
Scala
Stars
376
Forks
66
Avg merge
2d 13h
Merged PRs (30d)
3

Description

There are a bunch of different syntaxes in the mouse - for boxed primitive-like data types (Int, Long, Boolean, etc), for collections (Map, Set, List, etc), for nested things (F[Either[A, B]], F[Option[A]], etc). And as you probably already guessed, we can combine some of those in groups - mouse.collections, mouse.nested, etc. It'd be a bit nicer from a design perspective, as well as from navigation. But this would require us to do a new major release since that change isn't binary compatible. What do you think about it?

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 files or tests are named. Start by examining the root mouse package and the existing mouse.collections and mouse.nested groupings, then review how boxed primitive-like, collection, and nested syntaxes are organized. Done would require an agreed package layout and a plan for the incompatible major release.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.