Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31,894 创建于 2022年10月19日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)C# (4,880 star) (4,479 fork)batch import
ClientDocsMQhelp wanted

描述

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.

贡献者指南

技术栈
csharp
领域
backenddeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
needs investigation
前置要求
C#Azure SDK for .NET basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30
研究方向
Investigate how exception messages are currently generated in the Azure SDK for .NET. Review linked issues #31597 and #31598 for context on troubleshooting links. Consider designing a helper class that maps exception types to troubleshooting URLs. Analyze the feasibility of integrating with Roslyn analyzers to automate link injection. Start by examining the source code in the 'sdk' directory for examples of exception handling.
Consider if troubleshooting link information in exception messages could be automated · Azure/azure-sdk-for-net#31894 | Good First Issue