fbchat-dev/fbchat

Documentation

Open

#222 geöffnet am 21. Okt. 2017

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (406 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

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

Beschreibung

The documentation on ReadTheDocs is still lacking quite a bit, mostly in easy explainations for beginners, though a few functions also still remain undocumented. A partial TODO can be found here. Any help would be appreciated!

Contributor Guide

Research-Richtung
Lesen Sie die vorhandene Dokumentation und die TODO Liste. Wählen Sie eine undokumentierte Funktion, verfolgen Sie ihre Verwendung im Code und schreiben Sie die Dokumentation im vorhandenen Stil.
Tech Stack
python
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75