CommunityToolkit/WindowsCommunityToolkit

Links in XML comments need updating

Open

#3831 aperta il 11 mar 2021

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)C# (1403 fork)batch import
Hacktoberfestbug :bug:documentation :page_with_curl:good first issue

Metriche repository

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

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiorna i commenti XML per utilizzare riferimenti tipizzati, HTTPS, rimuovere le impostazioni locali e le stringhe di query.
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.
Meno di 1 ora
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
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90