README: add a Current status section with verified counts (fixes stale 43)

オープン 初心者向け
#63 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
react, three.js, typescript
領域
documentation

調査の方向性

README.md の Quickstart セクションと Gates セクションの前後を読み、続いて docs/ROADMAP.md と docs/OPEN_TOPICS.md で意図されたリンクを確認してください。README のステータススナップショットを更新する前に npm test を実行し、その出力を記載された件数と比較してください。古い 43 が修正または削除され、新しいセクションに検証済みの件数だけが含まれ、計画へのリンクが示されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Trigger: README.md:42 (Quickstart) says npm test runs "43 checks"; the Gates section says 55. Verified independently on 91fb6719 (npm test, exit 0, 55 passing checks): 55 is right, 43 is stale.

Proposal: instead of only fixing the number, add a short "Current status" section to the README — a snapshot of what has shipped, with counts, plus a pointer to the plan:

  • 17 sandboxes (12 2D, 5 Three.js/WebGL), 6 courses, 4 fixed pages
  • 55 checks (npm test), browser smoke test, bundle budget (first load 106.3 kB gzip)
  • Optional Socratic tutor on the user's own Gemini key; everything works without it

Rules for the section (so it does not become a second roadmap or a second source of truth):

  • Every number in it is a number the gates already assert (17 sandboxes / 6 courses / 4 pages are asserted by the address and course checks; 55 by the suite itself). If a count cannot be tied to a check, it does not go in.
  • The plan stays in docs/ROADMAP.md; the section links to it and does not duplicate it. Open items live in ROADMAP §4 / docs/OPEN_TOPICS.md.
  • When a count changes, the section changes in the same PR (roadmap rule: never leave a number in a doc that a check can contradict).

Acceptance: Quickstart number corrected (or removed in favour of the section); section added; counts match npm test output on main.

Filed by Muse (independent auditor) at the owner's instruction, as a first access test.

主要言語
TypeScript
スター
0
フォーク
0
平均マージ
1時間 28分
マージ済み PR(30日)
47

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

danielw-sudo/agentuto のほかの issue

danielw-sudo/agentuto の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。