CommunityToolkit/WindowsCommunityToolkit

Unify references to types in XML comments

Open

#3.441 aberto em 18 de ago. de 2020

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)C# (1.403 forks)batch import
Hacktoberfestdocumentation :page_with_curl:good first issuehelp wantedimprovements :sparkles:maintenance :gear:

Métricas do repositório

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

Description

Based on a comment in #3434, we should do a better job of consistency in our XML comments.

We should do an audit and then add guidance in our contributor docs.

Side note - we should unify the way we display langwords in XML comments throughout the repository. Right now we have some displayed as plain text, some as inline markdown code (true), some as XML code blocks (<c>true</c>), some as XML langwords (langword="true").

Originally posted by @Sergio0694 in https://github.com/windows-toolkit/WindowsCommunityToolkit/pull/3434#discussion_r472129802

Guia do colaborador

Direção de pesquisa
Audite os comentários XML existentes no repositório quanto ao uso inconsistente de referências a tipos (ex.: texto simples, código inline, código XML, langword). Proponha um formato consistente e atualize a documentação do contribuidor com as novas diretrizes.
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.
Meio dia
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80