jquery/sizzle

Reorganize docs

Open

#366 geöffnet am 11. Nov. 2015

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (991 Forks)batch import
help wanted

Repository-Metriken

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

Beschreibung

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

Contributor Guide

Research-Richtung
Verschieben Sie die API Dokumentation aus dem Wiki in die README.md, mit Schwerpunkt auf der Verwendung. Verschieben Sie dann die verbleibenden Richtlinien für Entwicklung und Beiträge in CONTRIBUTING.md und stellen Sie sicher, dass die README.md auf CONTRIBUTING.md verlinkt.
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.
90