Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31.894 aperta il 19 ott 2022

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)C# (4479 fork)batch import
ClientDocsMQhelp wanted

Metriche repository

Star
 (4880 star)
Metriche merge PR
 (Merge medio 5g 8h) (352 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga su come vengono attualmente generati i messaggi di eccezione in Azure SDK per .NET. Rivedi i problemi collegati #31597 e #31598 per il contesto sui collegamenti per la risoluzione dei problemi. Considera la progettazione di una classe helper che mappi i tipi di eccezione agli URL di risoluzione dei problemi. Analizza la fattibilità dell'integrazione con gli analizzatori Roslyn per automatizzare l'inserimento dei collegamenti. Inizia esaminando il codice sorgente nella directory 'sdk' per esempi di gestione delle eccezioni.
Tech stack
csharp
Dominio
backenddeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Richiede indagine
Prerequisiti
C#Azure SDK for .NET basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30