FGRibreau/check-build

Documentation

Open

#8 创建于 2014年11月3日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)JavaScript (33 fork)batch import
enhancementhelp wanted

仓库指标

Star
 (695 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Develop a tool like "check-docs" or "dox-check" to check that at least X% functions are documented per files. Something like jsinspect but for documentation.

Then add an interface to check-build.

PR are welcome for this!

贡献者指南

研究方向
开发一个工具来检查文档覆盖率（例如，每个文件中至少 X% 的函数有文档），并将其集成到 check build 界面中。
技术栈
javascriptnodejs
领域
developer experiencetoolingbuild system
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Node.jsnpm
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75