jquery/sizzle

Reorganize docs

Open

#366 创建于 2015年11月11日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)JavaScript (991 fork)batch import
help wanted

仓库指标

Star
 (6,264 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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.

贡献者指南

研究方向
将 API 文档从 wiki 迁移到 README.md，重点介绍用法。然后将剩余的开发和贡献指南移动到 CONTRIBUTING.md，并确保 README.md 链接到 CONTRIBUTING.md。
技术栈
javascript
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90