sinonjs/sinon

"API Specification" Style Documentation

Open

#2,003 创建于 2019年4月2日

在 GitHub 查看
 (14 评论) (1 反应) (0 负责人)JavaScript (9,548 star) (764 fork)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

描述

I would love to see API Specification style documentation for Sinon, along the lines of what you see in Java (the gold standard of documentation), or jQuery.

An A-Z alphabetical list of functionality, written in a non-conversational way (which is how the current documentation is currently written) is what this documentation needs.

贡献者指南

技术栈
javascript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
JavaScript basicsSinon API knowledge
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
20
研究方向
Review existing Sinon documentation structure and consider templates from jQuery API docs. Discuss with maintainers about scope and format. Possibly start with a single function like `sinon.spy` as a prototype.