eth0izzle/Needl

Write documentation

Open

#2 opened on Nov 16, 2016

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (51 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

Description

Mostly to explain what each module does and the options under data/settings.yaml.

Contributor guide

Research direction
Read the codebase to understand each module and the settings.yaml options, then write clear explanations.
Tech stack
python
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90