CommunityToolkit/WindowsCommunityToolkit

Links in XML comments need updating

Open

#3.831 geöffnet am 11. März 2021

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (1.403 Forks)batch import
Hacktoberfestbug :bug:documentation :page_with_curl:good first issue

Repository-Metriken

Stars
 (5.708 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Aktualisieren Sie XML Kommentare, um typisierte Referenzen, HTTPS zu verwenden, und entfernen Sie Gebietsschema und Abfragezeichenfolgen.
Tech Stack
csharp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90