docs: record go-code-standards progress - #79
Merged
Conversation
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>
|
Thank you for contributing to this project! 😊🕹️ |
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
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.
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
types.gocontaining a functionexport_test.goaliasing an unexported function3.5 does not pass, and is recorded rather than ticked.
Ten aliases exist — four in
gohaiand six inosapi— with eleven call sites depending on them:gohaicollectors/kernelBytesToString,DefaultUnamegohaicollectors/networkReadInterfacesgohaicollectors/linodeDefaultInterfaceAddrsosapiprovider/node/ntpComputeSHA256,GenerateContent,ParseOffset,ParseReferenceID,ParseSources,ParseTrackingThe requirement is not wrong.
gohaiwrote this rule into its ownCONTRIBUTING.mddeliberately, with the reason attached — aliases "enabled a secondTestReadXmethod that duplicates whatTestCollectalready 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
osapi, which needs a rootCONTRIBUTING.mdto restate the conventions in. Blocked onstandardize-repository-layouttask 4.5.🤖 Generated with Claude Code