Skip to content

docs: record go-code-standards progress - #79

Merged
retr0h merged 1 commit into
mainfrom
docs/go-standards-progress
Aug 16, 2026
Merged

docs: record go-code-standards progress#79
retr0h merged 1 commit into
mainfrom
docs/go-standards-progress

Conversation

@retr0h

@retr0h retr0h commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Records progress on specify-go-code-standards — 10 of 14. Four of the five Go repositories now restate the shared conventions and point at the capability.

Verifications

Task Check Result
3.1 types.go containing a function 0
3.2 Generically named files 0
3.3 Test packages without a suite 0
3.5 export_test.go aliasing an unexported function 10

3.5 does not pass, and is recorded rather than ticked.

Ten aliases exist — four in gohai and six in osapi — with eleven call sites depending on them:

Package Alias
gohai collectors/kernel BytesToString, DefaultUname
gohai collectors/network ReadInterfaces
gohai collectors/linode DefaultInterfaceAddrs
osapi provider/node/ntp ComputeSHA256, GenerateContent, ParseOffset, ParseReferenceID, ParseSources, ParseTracking

The requirement is not wrong. gohai wrote this rule into its own CONTRIBUTING.md deliberately, with the reason attached — aliases "enabled a second TestReadX method that duplicates what TestCollect already covers". Its own code has not caught up with it, which is the ordinary case for a rule that lived in one repository's documentation and was enforced by memory.

So this is debt the capability surfaced, not a requirement to soften. Removing the aliases means rewriting eleven call sites to exercise those functions through the surface that calls them — which is the point of the rule, and is real work worth its own change rather than being folded in here.

Still open

  • 2.5osapi, which needs a root CONTRIBUTING.md to restate the conventions in. Blocked on standardize-repository-layout task 4.5.
  • 3.4, 3.6 — run after 2.5, since both depend on osapi's state.

🤖 Generated with Claude Code

Four of five repositories restate the conventions and point at the
capability. Three verifications pass.

3.5 does not. Ten export_test.go files alias an unexported function,
four of them in gohai, which is the repository that wrote the rule
into its own CONTRIBUTING. Recorded rather than ticked.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Thank you for contributing to this project! 😊🕹️

@retr0h
retr0h merged commit eb193f0 into main Aug 16, 2026
6 checks passed
@retr0h
retr0h deleted the docs/go-standards-progress branch August 16, 2026 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant