linkedin / linkedin/photon-ml

Enumeration Consistency

Open
#238 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Terra
Stars
795
Forks
175
PR merge metrics
No merged PRs in 30d

Description

Currently we don't have much consistency in our use of Enumerations: some places we have Enums, some places we have case classes, and some places case objects. In some places, we use case objects and write our own `String` parsing code.

Ideally we would use one consistent system throughout. It looks like an [overhaul](https://github.com/lampepfl/dotty/issues/1970) to the Enum structure is on the way, but until it's out and until we're using that version of Scala, I propose we use the [Enumeratum](https://github.com/lloydmeta/enumeratum) library.

Contributor guide

No contributing guide indexed for this repository

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

The issue identifies no files, tests, or entry points. Begin by locating the project's enumeration definitions and confirming the supported Scala version, then determine the scope of replacing the existing patterns with Enumeratum and how consistency will be verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
developer-experience
Issue type
Refactor
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.