Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31,894 opened on Oct 19, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,479 forks)batch import
ClientDocsMQhelp wanted

Repository metrics

Stars
 (4,880 stars)
PR merge metrics
 (Avg merge 4d 23h) (574 merged PRs in 30d)

Description

In combination with #31597 and #31598 perhaps there is an opportunity to implement some automation in how troubleshooting links are added to exception messages generated for a given library. For example, perhaps each client has a helper that centralizes a mapping between types and troubleshooting links such that any exception thrown from that type includes the appropriate link. This could be enhanced with analyzer support.

Contributor guide

Research direction
Investigate current exception message generation patterns in the Azure SDK for .NET, identify where troubleshooting links are manually added, and design a helper or analyzer to automate linking types to troubleshooting URLs based on a centralized mapping. Evaluate feasibility and propose implementation steps.
Tech stack
csharp
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
C#Azure SDK
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40