Skip to content

chore(pkg): tag c1/c2 net+rte package comments with c<layer>-<domain> [HOLD]#3410

Draft
0pcom wants to merge 1 commit into
skycoin:developfrom
0pcom:chore/pkg-domain-layer-tags-net-rte
Draft

chore(pkg): tag c1/c2 net+rte package comments with c<layer>-<domain> [HOLD]#3410
0pcom wants to merge 1 commit into
skycoin:developfrom
0pcom:chore/pkg-domain-layer-tags-net-rte

Conversation

@0pcom

@0pcom 0pcom commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

DRAFT / HOLD — do not merge yet (pending sign-off on the domain/layer convention with Synth).

Overlays the skywire package taxonomy onto the mesh-spine packages: each file's existing // Package <name> <path> doc line gains a trailing c<layer>-<domain> tag, e.g. // Package transport pkg/transport/manager.go c2-net.

  • Doc-comment only — no code, no imports; package names stay idiomatic (transport.Manager).
  • Keeps revive package-comments happy (still leads with "Package ").
  • Greppable: grep -rn 'c[0-9]-net\|c[0-9]-rte' pkg/.

Scope (this pass): net (dmsg/dmsgc/skyquic = c1; transport/transport-setup/skyudpbridge/stunserver/tcpproxy/networkmonitor = c2) + rte (routing = c1; router/rfclient/skyroute = c2). 91 files. go build ./... + gofmt + golangci-lint all clean.

Taxonomy + the full 8-domain mapping (com/net/rte/cxo/dsc/app/vis/rwd) and the rationale for the doc-comment convention (vs the compiler/linter rejecting a name prefix) live in the standards derivation doc set. Remaining domains are a mechanical follow-up with the same tagger.

@0pcom 0pcom force-pushed the chore/pkg-domain-layer-tags-net-rte branch from 522bb75 to ce84311 Compare July 7, 2026 16:29
Overlays the skywire package taxonomy (../kcg-game-standards-golang/
domains-golang.txt) onto the net-domain mesh spine: each file's existing
'// Package <name> <path>' doc line gains a trailing c<layer>-<domain>-<system>
tag, e.g. '// Package transport pkg/transport/manager.go c2-net-transport'.
Doc-comment only — no code, no imports; package names stay idiomatic. Keeps
revive package-comments happy and is greppable (grep -rn 'c[0-9]-net-' pkg/).

Systems this pass: net.dmsg (dmsg/dmsgc c1), net.transport (skyquic/transport/
transport-setup/skyudpbridge/stunserver/tcpproxy c1|c2), net.routing (routing c1;
router/rfclient/skyroute c2), net.monitor (networkmonitor c2). 91 files.
go build ./... + gofmt + golangci-lint clean. Remaining net systems (cxo,
discovery) + app/vis/com domains are a mechanical follow-up.

Domain set = 3 functional domains (net/app/vis) + a com c0 base, with the detail
in SYSTEMS (per Synth: 1-3 domains, push detail into systems).
@0pcom 0pcom force-pushed the chore/pkg-domain-layer-tags-net-rte branch from ce84311 to 453e0c4 Compare July 7, 2026 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant