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

Update HugeIcons library 未關閉

難度 2/5 1-3 小時新手友好度 65/100

antfu-collective/icones#398 · 2026年9月24日建立
ECmail.com 未關閉

難度 1/5 1 小時以內新手友好度 90/100

wesbos/burner-email-providers#554 · 2026年9月24日建立
Default dort filter shows warning 未關閉

難度 2/5 1-3 小時新手友好度 65/100

radiantearth/stac-browser#1023 · 2026年9月24日建立
HMR stops working 未關閉

難度 2/5 1-3 小時新手友好度 75/100

ryan-haskell/vite-plugin-elm-watch#20 · 2026年9月24日建立
Page caching: document the warm origin, and that rendering and warming need different URLs 未關閉

難度 2/5 1-3 小時新手友好度 75/100

components-web-app/docs#92 · 2026年9月24日建立

更多 JavaScript Issue