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.
"API Specification" Style Documentation · sinonjs/sinon#2003 | Good First Issue