Clean up README

オープン

#649 2018年12月19日に作成コメント 2 件リアクション 3 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 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 にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

debug-js/debug のほかの issue

Add documentation around using ESM imports オープン

難易度 1/5 1時間未満初心者へのやさしさ 82/100

debug-js/debug#1019 · コメント 1 件 · リアクション 2 件 · 2025年11月11日に作成
propose for npm trusted publishing with OIDC オープン

難易度 4/5 3〜5日初心者へのやさしさ 25/100

debug-js/debug#1010 · コメント 5 件 · リアクション 5 件 · 2025年9月9日に作成
Debug as JSON オープン

難易度 5/5 1週間以上初心者へのやさしさ 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 をもっと見る