docs: add Go code style guide for contributors#1046
Open
Conversation
Covers package naming and directory layout, interface design patterns (define at use site, small interfaces, idempotency docs, registry pattern), logging conventions for zap and controller-runtime logr, TODO comment format enforcement, and test file organization (naming, table-driven tests, mock generation with mamockgen). Draws examples from existing Backend/Registry/Reconciler code. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
File is at docs/contributing/dev/go/ so links to contributing/ root require ../../, not ../ Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
docs/contributing/dev/go/code-style.mdContent:
cmd/vscomponents/), when to use eachBackend/Registry/JobQueuecodeTODO(#issue): description— explains the CI enforcement and how to complypackage foovspackage foo_test, test function naming pattern, mock generation withmamockgen, table-driven testsAll code examples are derived from existing production code (
inferenceserver/backends/,scheduler/).Why
error-handling.mdexists and is thorough. Contributors working on package structure, interface design, and logging conventions have no equivalent reference. This was priority 9 in the proposal doc.Test plan
mamockgenis the actual mock generator used in the repobackendsmocks) matches actual generated dirs🤖 Generated with Claude Code