Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31.894 geöffnet am 19. Okt. 2022

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C# (4.479 Forks)batch import
ClientDocsMQhelp wanted

Repository-Metriken

Stars
 (4.880 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 8h) (352 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche, wie Ausnahmemeldungen derzeit im Azure SDK für .NET generiert werden. Überprüfe die verknüpften Issues #31597 und #31598 für den Kontext zu Troubleshooting Links. Erwäge die Gestaltung einer Hilfsklasse, die Ausnahmetypen auf Troubleshooting URLs abbildet. Analysiere die Machbarkeit der Integration mit Roslyn Analyzern zur Automatisierung der Link Injektion. Beginne mit der Untersuchung des Quellcodes im Verzeichnis 'sdk' nach Beispielen für die Ausnahmebehandlung.
Tech Stack
csharp
Domain
backenddeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Recherche nötig
Voraussetzungen
C#Azure SDK for .NET basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30