thebigmunch/audio-metadata

Add more code comments

Open

#19 opened on Feb 15, 2020

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

Repository metrics

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

Description

I used to be very good about adding comments to code. But, with a reduction in hobby coding time comes sacrifices. Much of this code could benefit from some helpful comments, including links to applicable resources.

Contributor guide

Research direction
Read the codebase and identify areas lacking comments; add inline comments and links to relevant resources.
Tech stack
python
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.
Under 1 hour
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