Azure/azure-sdk-for-net

Consider if troubleshooting link information in exception messages could be automated

Open

#31.894 aberto em 19 de out. de 2022

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4.479 forks)batch import
ClientDocsMQhelp wanted

Métricas do repositório

Stars
 (4.880 stars)
Métricas de merge de PR
 (Mesclagem média 5d 8h) (352 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue como as mensagens de exceção são atualmente geradas no Azure SDK para .NET. Revise as issues vinculadas #31597 e #31598 para contexto sobre links de solução de problemas. Considere projetar uma classe auxiliar que mapeie tipos de exceção para URLs de solução de problemas. Analise a viabilidade de integração com analisadores Roslyn para automatizar a injeção de links. Comece examinando o código fonte no diretório 'sdk' para exemplos de tratamento de exceções.
Pilha de tecnologia
csharp
Domain
backenddeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Precisa de investigação
Prerequisites
C#Azure SDK for .NET basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30