sinonjs/sinon

"API Specification" Style Documentation

Aperta

#2003 aperta il 2 apr 2019

Vedi su GitHubGuida contributor
 (14 commenti) (1 reazione) (0 assegnatari)JavaScript (764 fork)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

Metriche repository

Star
 (9548 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Guarda la struttura della documentazione esistente, trova una funzione non ancora documentata nello stile A Z e aggiungi una voce di riferimento API concisa seguendo il modello della documentazione Java o jQuery.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80