OneLiteFeatherNET / OneLiteFeatherNET/Voyager
feat(arch): introduce shared/api module for pure interfaces, enums and exceptions
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 0
- Forks
- 0
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 12
Description
Context
Currently shared/common acts as both the API boundary (interfaces, enums, exceptions) and the implementation layer. ManisGame separates these cleanly into a shared/api module (zero implementations, no platform imports) and a shared/common module (implementations only).
Goal
Extract the following from shared/common into a new :shared:api Gradle module:
- All domain interfaces (e.g.
CupService,MapService,LanguageService) - All enums used across modules
- All domain-specific exception classes
Acceptance Criteria
-
:shared:apimodule exists insettings.gradle.kts -
shared/apihas zero implementation classes -
shared/apihas no Minestom or Paper imports -
shared/commondepends on:shared:api, not the other way around - ArchUnit rule
shared_common_must_not_use_minestomstill passes - ADR written before any code moves
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 settings.gradle.kts and inspect shared/common to inventory the interfaces, enums, and domain exceptions named in the issue. Write the ADR before moving code, then verify that shared/api contains no implementations or Minestom/Paper imports, shared/common depends on it, and the shared_common_must_not_use_minestom ArchUnit rule still passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100