moscajs/mosca

Write documentation in plain markdown

Offen

#501 geöffnet am 18.06.2016

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (498 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (3.186 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Currently the documentation is written inlined in the code, using a (now-broken) documentation generation system.

We should rewrite this into a doc folder just using "plain" markdown.

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Inline Dokumentation im Quellcode und erstellen Sie einen neuen Ordner 'doc' mit einfachen Markdown Dateien, die den Inhalt strukturiert wiedergeben.
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.
Halber Tag
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
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90