TeamNewPipe/NewPipe

[ Feature Request ] In Code and General Documentation

Open

#2,725 opened on Oct 14, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (38,153 stars) (3,577 forks)batch import
discussionhelp wantedmeta

Description

There doesn't seem to be an appropriate amount of comments. This is pretty concerning as it means that new contributors (ie. me) may be somewhat lost. I know that this wont improve the functionality of the code directly, but it will make the code more approachable to new contributors. I plan to write some more in code and out of code docs as i become familiar with the project, but I would appreciate some help with this fairly large task. So if you have some free time feel free to work on some docs. 😊

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.
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Java knowledgebasic Android development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the codebase to identify classes and methods lacking comments. Focus on the main source directories (e.g., app/src/main/java/org/schabi/newpipe/). Add Javadoc comments for public APIs and inline comments for complex logic. Check existing contribution guidelines for comment style. Start with a single class to keep changes small.