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,479 forks)batch import
ClientDocsMQhelp wanted

Repository metrics

Stars
 (4,880 stars)
PR merge metrics
 (平均マージ 4d 23h) (30d で 574 merged PRs)

説明

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.

コントリビューターガイド

調査方針
Azure SDK for .NET における現在の例外メッセージ生成パターンを調査し、トラブルシューティングリンクが手動で追加されている場所を特定し、集中管理されたマッピングに基づいて型をトラブルシューティングURLに自動的にリンクするヘルパーまたはアナライザーを設計します。実現可能性を評価し、実装手順を提案します。
技術スタック
csharp
領域
backendapi
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
調査が必要
前提条件
C#Azure SDK
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40