prikhi/pencil

code uncommented, hard to read: Help adding comments

Open

#704 建立於 2015年6月5日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)JavaScript (1,933 star) (199 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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