Improve XML doc comments and CONTRIBUTING.md#22
Merged
Conversation
- Add <param>, <returns>, and <exception> tags to public API methods in MigrationDiffService, ConflictDetectionService, CacheService, EventBus, and PluginSystem - Expand CONTRIBUTING.md with prerequisites, architecture overview, code review checklist, and guide for adding new output formats - Ensure all public-facing methods have complete IntelliSense metadata
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
<param>,<returns>, and<exception>XML documentation tags to public API methods across core services:MigrationDiffService,ConflictDetectionService,CacheService,EventBus, andPluginSystemCONTRIBUTING.mdwith prerequisites section, development setup instructions, architecture overview diagram, code review checklist, and a step-by-step guide for adding new output formatsChanged Files
Services/MigrationDiffService.cs- Detailed param/returns docs onCompareBranches,CompareDbContextMigrations,GenerateReportServices/ConflictDetectionService.cs- Param/returns docs onDetectConflicts,IsValidTableName,IsValidColumnNameCaching/CacheService.cs- Full typeparam/param/returns/exception docs onSet<T>,TryGet<T>,Get<T>Events/EventBus.cs- Typeparam/param/exception docs onSubscribe,Unsubscribe,PublishAsyncPlugins/PluginSystem.cs- Param/returns docs onGetPlugin,ExecuteHookAsyncCONTRIBUTING.md- Complete rewrite with architecture overview, review checklist, and contributor workflowTest Plan
dotnet buildcompiles without warnings