sinonjs/sinon

"API Specification" Style Documentation

Offen

#2.003 geöffnet am 02.04.2019

Auf GitHub ansehenContributor Guide
 (14 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (764 Forks)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

Repository-Metriken

Stars
 (9.548 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Sieh dir die bestehende Dokumentationsstruktur an, finde eine Funktion, die noch nicht im A Z Stil dokumentiert ist, und füge einen prägnanten API Referenzeintrag nach dem Vorbild der Java oder jQuery Dokumentation hinzu.
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80