typelevel / typelevel/natchez

Flat code structure

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

Nobody has claimed this yet.

Dominant language
Scala
Stars
340
Forks
76
Avg merge
1d 6h
Merged PRs (30d)
13

Description

Is there a reason why the source code doesn't follow the usual Scala layouts for packaging? For example, code under modules/core/shared/src/main/scala are written to be in package natchez. However, they are not actually in a sub-directory natchez which is the usual Scala convention.

Although Scala doesn't enforce it, most Scala code follow this convention.

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

Start by inspecting modules/core/shared/src/main/scala and the files declared in package natchez. Determine whether adopting the usual Scala directory layout is intended and identify the full scope of any required source reorganization; done should include a documented decision and a consistently applied layout.

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.