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 (1,933 stars) (199 forks)batch import
DocsPriority-Criticalenhancementhelp wanted

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

Tech stack
javascript
Domain
documentationdeveloper experience
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-2 days
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.
mostly clear
Prerequisites
basic JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Start by reviewing the repository's code structure to identify key files and functions that lack comments. Check the issue comments for any specific areas mentioned by the community. Focus on adding descriptive comments at the top of each file and before function definitions, following any existing comment style. Since the repository is deprecated, ensure any contributions are still welcomed by maintainers before proceeding.