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.