seangwright/typescript-functional-extensions

Docs: More Consistent JSDoc comments

Ouverte

#1 ouverte le 27 déc. 2021

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)TypeScript (6 forks)auto 404
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (39 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

The language describing methods/parameters/return types isn't very consistent across the library.

We need to decide on a few things and then clean it all up:

  • Past/present tense
  • Verbose vs terse method description
    • Details in description or param/return type annotations
  • Comments just for method overload signatures or also for implementation
  • Comments on utility types

Guide contributeur

Direction de recherche
Examinez les commentaires JSDoc existants dans le code, identifiez les incohérences et proposez un guide de style pour les commentaires JSDoc.
Stack technique
typescript
Domaine
Aucun
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
typescript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90