Clean up README

未关闭

#649 创建于 2018年12月19日 2 条评论 3 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 2/5
预计耗时: 1-3 小时
新手友好度: 38/100

Issue 类型: 文档
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: javascript
领域: documentation

调研方向

Start with the repository README and compare its current structure with the requested sections: one screenshot, title and summary, installation, basic usage, API documentation, examples, Open Collective, and license. Remove redundant examples, explanations, and screenshots while preserving the listed content. Done means the README is concise and contains the requested single screenshot and sections.

由索引模型根据 Issue 内容生成。

描述

change-patch pr-welcome

Debug has a simple API with a handful of static-/member-methods. It has been relatively unchanged since its conception (yes, users of 0.x can most likely upgrade to the latest major without any problems).

However, the README currently reflects a manual (nay, a bible) of integrated examples, etc. for a library that should be easily grok-able in just a few moments' time.

Not every method call needs three examples, nor does it need several paragraphs explaining the intricacies of how the method is useful.

Further, the use of screenshots is egregious. They add several pagefuls of redundant information.

Let's minimize the README to just:

Single screenshot (very top, centered)
Title; summary
Installation
Basic usage
API documentation
Examples
Open Collective et al
License

主要语言: JavaScript
星标: 11.5k
派生: 992
PR 合并指标: 30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

debug-js/debug 的其他 Issue

Add documentation around using ESM imports 未关闭

难度 1/5 1 小时以内新手友好度 82/100

debug-js/debug#1019 · 1 条评论 · 2 个 reaction · 2025年11月11日创建
propose for npm trusted publishing with OIDC 未关闭

难度 4/5 3-5 天新手友好度 25/100

debug-js/debug#1010 · 5 条评论 · 5 个 reaction · 2025年9月9日创建
Debug as JSON 未关闭

难度 5/5 一周以上新手友好度 25/100

debug-js/debug#1008 · 2025年9月8日创建
console.group and groupCollapsed 未关闭

难度 3/5 1-2 天新手友好度 35/100

debug-js/debug#1002 · 2025年7月30日创建
`.extend` is undefined in cloudflare workers 未关闭

难度 3/5 1-2 天新手友好度 28/100

debug-js/debug#999 · 6 条评论 · 2025年5月24日创建

查看 debug-js/debug 的全部 Issue

相似的 Issue

Ajv defaults: non-standard "format": "json" in third-party schemas (e.g. Notion) warns twice per property — register it like #2601 未关闭

难度 2/5 1-3 小时新手友好度 70/100

modelcontextprotocol/typescript-sdk#2854 · 2026年9月24日创建
[Bug]: ctx_search rejects singular 'query' param despite schema declaring it valid 未关闭

难度 2/5 1-3 小时新手友好度 75/100

mksglu/context-mode#1200 · 2026年9月24日创建
Duplicated 'Connect to Database Using C#' link in Postgres Tutorial Page 未关闭

难度 2/5 1-3 小时新手友好度 75/100

neondatabase/website#5944 · 2026年9月24日创建
bbb-conf --set-port-range writes port values as YAML strings, so mediasoup ignores the configured range 未关闭

module: core

难度 2/5 1-3 小时新手友好度 75/100

bigbluebutton/bigbluebutton#25849 · 2026年9月24日创建
[chore]: test(search): Migrate ResultItemTitle unit tests to TypeScript 未关闭

难度 2/5 1-3 小时新手友好度 75/100

jaegertracing/jaeger-ui#4506 · 2026年9月24日创建

更多 JavaScript Issue