CommunityToolkit/WindowsCommunityToolkit

Links in XML comments need updating

Open

#3 831 ouverte le 11 mars 2021

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)C# (1 403 forks)batch import
Hacktoberfestbug :bug:documentation :page_with_curl:good first issue

Métriques du dépôt

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

Description

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

Guide contributeur

Direction de recherche
Mettez à jour les commentaires XML pour utiliser des références typées, HTTPS, supprimer les paramètres régionaux et les chaînes de requête.
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.
Moins d'une heure
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
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90