umputun/feed-master

we need a decent documentation

Open

#53 opened on Mar 24, 2022

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (27 forks)github user discovery
help wanted

Repository metrics

Stars
 (140 stars)
PR merge metrics
 (PR metrics pending)

Description

The current documentation is not that useful and without examples it is impossible to figure how to configure things and how all of this supposed to work. With yt support things got even more complicated.

Contributor guide

Research direction
Review the current documentation and add clear examples for configuration and YT support. Start by examining the project's README and existing comments in the codebase.
Tech stack
go
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.
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
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75