CommunityToolkit/WindowsCommunityToolkit

Links in XML comments need updating

Open

#3.831 aberto em 11 de mar. de 2021

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees)C# (1.403 forks)batch import
Hacktoberfestbug :bug:documentation :page_with_curl:good first issue

Métricas do repositório

Stars
 (5.708 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Describe the bug

We need to update our XML comments to have better standards for when they're generated into docs:

  • ideally use a typed reference vs. a specific url link
  • use https instead of http
  • not include locale like en-us in the link url
  • don't link to specific views with query-strings to docs

Guia do colaborador

Direção de pesquisa
Atualize os comentários XML para usar referências tipadas, HTTPS, remover localidade e strings de consulta.
Pilha de tecnologia
csharp
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90