jquery/sizzle

Reorganize docs

Open

#366 建立於 2015年11月11日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)JavaScript (6,264 star) (991 fork)batch import
help wanted

描述

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Markdown syntaxGit basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Examine the current README.md and CONTRIBUTING.md files. Identify sections in README that are more about contributing (e.g., build instructions, testing) and move them to CONTRIBUTING.md. Then update README to focus on usage and link to the wiki for API documentation. Ensure links are updated.