Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31 894 ouverte le 19 oct. 2022

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)C# (4 479 forks)batch import
ClientDocsMQhelp wanted

Métriques du dépôt

Stars
 (4 880 stars)
Métriques de merge PR
 (Merge moyen 5j 8h) (352 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Étudiez comment les messages d'exception sont actuellement générés dans le SDK Azure pour .NET. Consultez les problèmes liés #31597 et #31598 pour le contexte sur les liens de dépannage. Envisagez de concevoir une classe d'assistance qui mappe les types d'exception aux URL de dépannage. Analysez la faisabilité de l'intégration avec les analyseurs Roslyn pour automatiser l'injection de liens. Commencez par examiner le code source dans le répertoire 'sdk' pour des exemples de gestion des exceptions.
Stack technique
csharp
Domaine
backenddeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Investigation requise
Prérequis
C#Azure SDK for .NET basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30