sinonjs/sinon

"API Specification" Style Documentation

Open

#2 003 ouverte le 2 avr. 2019

Voir sur GitHub
 (14 commentaires) (1 réaction) (0 assignés)JavaScript (764 forks)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

Métriques du dépôt

Stars
 (9 548 stars)
Métriques de merge PR
 (Merge moyen 6j 16h) (15 PRs mergées en 30 j)

Description

I would love to see API Specification style documentation for Sinon, along the lines of what you see in Java (the gold standard of documentation), or jQuery.

An A-Z alphabetical list of functionality, written in a non-conversational way (which is how the current documentation is currently written) is what this documentation needs.

Guide contributeur

Direction de recherche
Examinez la structure de la documentation existante, trouvez une fonction non encore documentée dans le style A Z et ajoutez une entrée de référence API concise en suivant le modèle de la documentation Java ou jQuery.
Stack technique
javascript
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80