TeamNewPipe/NewPipe

[ Feature Request ] In Code and General Documentation

Open

#2.725 geöffnet am 14. Okt. 2019

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (3.577 Forks)batch import
discussionhelp wantedmeta

Repository-Metriken

Stars
 (38.153 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 17h) (17 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Identifiziere Teile des Codes mit wenigen Kommentaren und füge erklärende Kommentare hinzu. Trage auch zur Projektdokumentation bei, z. B. zu einem Leitfaden für Mitwirkende oder Verbesserungen der README.
Tech Stack
javaandroid
Domain
mobile
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaAndroid
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85