Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31,894 opened on 2022年10月19日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)C# (4,880 stars) (4,479 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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