justcallmekoko/PythonDiscordBot

Create better man page for each plugin

Open

#86 opened on Apr 25, 2022

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (6 forks)github user discovery
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (56 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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 direction
Examine existing plugin usage strings, standardize them to follow Linux man page conventions (e.g., synopsis, description, options). Create a template and update each plugin.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65