justcallmekoko/PythonDiscordBot

Create better man page for each plugin

Offen

#86 geöffnet am 25.04.2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (6 Forks)github user discovery
documentationenhancementgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

Each plugin has a usage string in its code. This usage string needs to be standardized and practical. Make it more Linux CLI-like

Contributor Guide

Research-Richtung
Untersuche die vorhandenen Nutzungsstrings der Plugins und standardisiere sie nach den Konventionen von Linux Manpages (z. B. Zusammenfassung, Beschreibung, Optionen). Erstelle eine Vorlage und aktualisiere jedes Plugin.
Tech Stack
python
Domain
backend
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
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65