willowtreeapps/Hyperion-Android

How about a little readme in each plugin's directory?

Open

#95 opened on Apr 13, 2018

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Java (1,877 stars) (138 forks)batch import
help wanted

Description

To easily convey what the plugin does, what it looks like etc. Or maybe some wiki pages? Or both?

Contributor guide

Tech stack
javaandroid
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of plugin directoriesBasic markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Examine the existing plugin directories under the plugins folder in the repository. Look at the structure and pick one plugin to write a simple README.md describing its purpose, usage, and a screenshot if possible. Ensure the README follows markdown format and is placed in the plugin's root directory. This issue asks for adding a README to each plugin directory, but a starting point can be one plugin to demonstrate the format.