docs(sdk): add Go SDK design specifications#6
Closed
rhuss wants to merge 1 commit into
Closed
Conversation
Include the spec-driven development artifacts that document the design decisions, architecture rationale, and research behind each SDK feature. These specs served as the implementation blueprints and provide ongoing design documentation. Retention in the repository is at the discretion of upstream maintainers. Assisted-By: 🤖 Claude Code Signed-off-by: Roland Huß <rhuss@redhat.com>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Owner
Author
|
Closing to recreate after PR #5 is recreated. |
rhuss
added a commit
that referenced
this pull request
Jul 15, 2026
- Remove dead boolCount function that would fail golangci-lint (#1) - Emit EventAdded for the first watch event instead of EventModified, matching k8s watch semantics (#7) - Add mutex locking to all mock server methods that access the shared sandboxes map, fixing latent race conditions (#12) - Skip HealthCheck integration test that calls an unimplemented stub (#13) - Scope doc.go examples: mark sections for sub-clients not yet available in this PR with "available in a future release" (#4) - Document Config.Timeout/RetryPolicy/Logger and WatchOptions fields as reserved for future use (#2, #6) Signed-off-by: Roland Huß <rhuss@redhat.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
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
Add design specifications from the spec-driven development process used to build the Go SDK.
This PR depends on #5 (the SDK itself) and adds 19 spec directories under
sdk/go/specs/, each containing:spec.md- Feature specification with acceptance scenariosplan.md- Implementation plan with architecture decisionsresearch.md- Technical research and alternatives considereddata-model.md- Entity relationships and data structuresQuestion for maintainers: Should these specs be retained as living documentation, or removed after the SDK PR is reviewed? They document the rationale behind each design decision but are not required for the SDK to function.
File Tree
79 files, ~10k lines of design documentation.