CommunityToolkit/WindowsCommunityToolkit

Unify references to types in XML comments

Open

#3 441 ouverte le 18 août 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)C# (1 403 forks)batch import
Hacktoberfestdocumentation :page_with_curl:good first issuehelp wantedimprovements :sparkles:maintenance :gear:

Métriques du dépôt

Stars
 (5 708 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Auditez les commentaires XML existants dans le dépôt pour vérifier l'utilisation incohérente des références de types (par exemple, texte brut, code en ligne, code XML, langword). Proposez un format cohérent et mettez à jour la documentation des contributeurs avec les nouvelles directives.
Stack technique
csharp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80