tsdjs/tsd

Improve documentation

Open

#55 ouverte le 13 nov. 2019

Voir sur GitHub
 (12 commentaires) (0 réactions) (0 assignés)TypeScript (68 forks)user submission
help wantedquestion

Métriques du dépôt

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

Description

I think we need to improve the documentation a bit. But I'm not sure how to provide the right amount of information.

So any ideas here are more than welcome. Like, should we add more examples? Should we add an example per assertion to make it more clear? Is the description good enough?

Guide contributeur

Direction de recherche
Examinez la documentation et les exemples existants, identifiez les lacunes et proposez des améliorations spécifiques telles que l'ajout d'un exemple par assertion ou la clarification des descriptions.
Stack technique
typescript
Domaine
documentationdeveloper experience
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85