prikhi/pencil

code uncommented, hard to read: Help adding comments

Open

#704 opened on 2015年6月5日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)JavaScript (1,933 stars) (199 forks)batch import
DocsPriority-Criticalenhancementhelp wanted

説明

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.

コントリビューターガイド

技術スタック
javascript
領域
documentationdeveloper experience
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
basic JavaScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
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.
code uncommented, hard to read: Help adding comments · prikhi/pencil#704 | Good First Issue