docs(rfc): propose base/ namespace for shared layer#239
Draft
behinddwalls wants to merge 1 commit into
Draft
Conversation
091810d to
e93652f
Compare
## Summary ### Why? The repo's shared cross-domain packages (`core/`, `entity/`, `extension/`) use the same bare names, at the same nesting level, as each domain's own packages (`submitqueue/core/`, `submitqueue/entity/`, ...). The domain side is namespaced by its domain folder and reads unambiguously; the shared side is the unqualified one, so a bare "core" or "entity" in a review, commit, or search is ambiguous. The collision is structural, not a problem with any one word — renaming a single package (e.g. `core/` → `base/`) does not generalize to `entity`/`extension` and would leave an inconsistent, half-fixed scheme. ### What? Adds `doc/rfc/shared-layer-namespace.md` proposing that the three shared packages move under one umbrella namespace, `base/` (`base/core`, `base/entity`, `base/extension`), leaving every domain's bare `core`/`entity`/`extension` untouched. The RFC recommends `base`, names `shared` as the close runner-up, records why `internal` (Go visibility breaks `example/`+`test/` imports) and per-package renames were rejected, and scopes the change as a mechanical no-op rename to land in a follow-up PR. Also links the RFC from `doc/rfc/index.md` under Shared. The final umbrella word is the main open question for reviewers.
e93652f to
a3cc69d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why?
The repo's shared cross-domain packages (
core/,entity/,extension/) use the same bare names, at the same nesting level, as each domain's own packages (submitqueue/core/,submitqueue/entity/, ...). The domain side is namespaced by its domain folder and reads unambiguously; the shared side is the unqualified one, so a bare "core" or "entity" in a review, commit, or search is ambiguous. The collision is structural, not a problem with any one word — renaming a single package (e.g.core/→base/) does not generalize toentity/extensionand would leave an inconsistent, half-fixed scheme.What?
Adds
doc/rfc/shared-layer-namespace.mdproposing that the three shared packages move under one umbrella namespace,base/(base/core,base/entity,base/extension), leaving every domain's barecore/entity/extensionuntouched. The RFC recommendsbase, namessharedas the close runner-up, records whyinternal(Go visibility breaksexample/+test/imports) and per-package renames were rejected, and scopes the change as a mechanical no-op rename to land in a follow-up PR. Also links the RFC fromdoc/rfc/index.mdunder Shared.The final umbrella word is the main open question for reviewers.