docs: establish Manager/Service/Provider/Runtime naming convention#140
Merged
mivertowski merged 1 commit intomainfrom Apr 22, 2026
Merged
docs: establish Manager/Service/Provider/Runtime naming convention#140mivertowski merged 1 commit intomainfrom
mivertowski merged 1 commit intomainfrom
Conversation
Document the type-suffix taxonomy for v1.0.0 GA so new code follows a consistent, reviewable pattern rather than the current interchangeable usage of Manager/Service/Provider/Runtime. The convention applies to new code only — existing public types are grandfathered to avoid breaking API consumers (Orleans.GpuBridge.Core and downstream). A future-rename list is included so reviewers can flag candidates for the next major version. - Add docs/conventions/naming.md with the taxonomy, flowchart, fit examples, new-code checklist, 8 future-rename candidates, and scope-exclusion notes. - Reference the convention from CLAUDE.md under Development Guidelines so contributors see it without hunting. Docs-only change. 0 warnings, 0 errors. Unit tests unaffected. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
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
docs/conventions/naming.mddefining the type-suffix taxonomy (Manager / Service / Provider / Runtime / Analyzer / Helpers) so new code for v1.0.0 GA follows a consistent, reviewable pattern rather than today's interchangeable usage.SecurityAlertManagerreally acts as a Service,CudaCapabilityManageris a stateless facade, the threePluginLifecycleManagerduplicates) — informational only, no renames performed because they are public API breaks.CLAUDE.mdunder Development Guidelines (3 lines) so contributors see it without hunting.Scope and limits
PoolReturnManagerinCudaStreamPool.cs) is also dead code — never constructed anywhere in the codebase — so the right action is removal, not rename. Documented in the future-rename list instead.Test plan
dotnet build DotCompute.sln --configuration Release→ 0 errors, 0 warnings.dotnet test DotCompute.sln --configuration Release --no-build --filter "Category=Unit"→ all 511 unit tests pass, no regressions. (Docs-only change, no code impact.)docs/conventions/naming.mdrenders correctly with the table, flowchart, examples, checklist, and future-rename section.CLAUDE.mdhas a 3-line reference to the new doc.🤖 Generated with Claude Code