CommunityToolkit/WindowsCommunityToolkit

Unify references to types in XML comments

Open

#3441 aperta il 18 ago 2020

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)C# (1403 fork)batch import
Hacktoberfestdocumentation :page_with_curl:good first issuehelp wantedimprovements :sparkles:maintenance :gear:

Metriche repository

Star
 (5708 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Controlla i commenti XML esistenti nel repository per verificare l'uso incoerente dei riferimenti ai tipi (ad es. testo semplice, codice inline, codice XML, langword). Proponi un formato coerente e aggiorna la documentazione per i contributori con le nuove linee guida.
Tech stack
csharp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80