manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 geöffnet am 1. Aug. 2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (132 Forks)github user discovery
documentationenhancementgood first issuehacktoberfest

Repository-Metriken

Stars
 (200 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Since auto documentation generation depends on JS DocStrings, there is need to fix and provide as much information possible.

Reference: http://usejsdoc.org/index.html

Contributor Guide

Research-Richtung
Überprüfe die vorhandenen JSDoc Kommentare im Codebestand und aktualisiere sie gemäß dem JSDoc Standard (usejsdoc.org). Stelle sicher, dass Funktionen, Parameter und Rückgabetypen ordnungsgemäß dokumentiert sind.
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90