prikhi/pencil

code uncommented, hard to read: Help adding comments

开放

#704 创建于 2015年6月5日

在 GitHub 查看
 (6 条评论) (0 个反应) (0 位负责人)JavaScript (199 个派生)batch import
DocsPriority-Criticalenhancementhelp wanted

仓库指标

星标
 (1,933 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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
领域
desktop
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75