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 (9 548 stars) (764 forks)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

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

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.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
over 1 week
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
JavaScript basicsSinon API knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
20
Direction de recherche
Review existing Sinon documentation structure and consider templates from jQuery API docs. Discuss with maintainers about scope and format. Possibly start with a single function like `sinon.spy` as a prototype.