fastify/avvio

Improve documentation

Open

#24 opened on Sep 18, 2017

View on GitHubContributor guide
 (5 comments) (1 reaction) (0 assignees)JavaScript (44 forks)github user discovery
good first issue

Repository metrics

Stars
 (467 stars)
PR merge metrics
 (Avg merge 1h 5m) (5 merged PRs in 30d)

Description

At the moment the documentation is almost complex as the actual code, we should fix that.

Contributor guide

Research direction
Read the existing documentation and compare with code to identify gaps or complex parts.
Tech stack
javascriptnodejs
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80