prikhi/pencil

code uncommented, hard to read: Help adding comments

Open

#704 opened on Jun 5, 2015

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (199 forks)batch import
DocsPriority-Criticalenhancementhelp wanted

Repository metrics

Stars
 (1,933 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Context: Not a feature or bug of the application itself, but as a help for anyone who wants to improve this project Problem: The code is mainly uncommented and it is hard to get into it. Suggestion: To anyone who knows the code a bit: Please add comments to the code in particular on top of files and functions.

Contributor guide

Research direction
Explore the codebase to understand the main files and functions, then add descriptive comments at the top of files and before functions explaining their purpose and basic functionality.
Tech stack
javascript
Domain
desktop
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75