CommunityToolkit/WindowsCommunityToolkit

Unify references to types in XML comments

Open

#3.441 geöffnet am 18. Aug. 2020

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (1.403 Forks)batch import
Hacktoberfestdocumentation :page_with_curl:good first issuehelp wantedimprovements :sparkles:maintenance :gear:

Repository-Metriken

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

Beschreibung

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

Contributor Guide

Research-Richtung
Prüfen Sie vorhandene XML Kommentare im Repository auf inkonsistente Verwendung von Typreferenzen (z. B. Klartext, Inline Code, XML Code, Langword). Schlagen Sie ein einheitliches Format vor und aktualisieren Sie die Mitwirkenden Dokumentation mit den neuen Richtlinien.
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.
Halber Tag
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80