docs(sound): READMEs do not say that sound and music start muted

オープン
#510 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

@stanislaw-ch がすでに取り組んでいます。

2026年11月11日 から。

  • #512 @stanislaw-ch による — オープン

評価

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

調査の方向性

Read modules/sound/README.md and modules/music/README.md, then compare their mute guidance with the initialization and class TSDoc in modules/sound/src/sound.library.ts and modules/music/src/music.library.ts. The issue suggests documenting that both start muted and calling mute() enables audio, or changing the default; a linked open pull request already addresses this issue.

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

説明

documentation good first issue modules:music modules:sound
What is the type of issue?

Documentation is missing

What is the issue?

Both libraries set _muted = true in __init. A user who follows the README (load then play) hears nothing until they call mute(), which the README only describes as a toggle. No docs/docs page exists for sound or music.

Evidence:

private _muted = true;
...
this._muted = true;

Suggested fix: State "starts muted; call mute() once to enable audio" in both READMEs and the class TSDoc, or start unmuted.

Found during a code audit of main at be72076.

Where did you find it?
主要言語
TypeScript
スター
7
フォーク
2
平均マージ
1日 17時間
マージ済み PR(30日)
17

環境構築

はじめの一歩

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

NanoForge-dev/Engine のほかの issue

NanoForge-dev/Engine の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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