docs(sound): READMEs do not say that sound and music start muted
维护者通常 1 天内回复
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 20/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- typescript
调研方向
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 内容生成。
描述
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 小时
- 30 天内合并 PR
- 17
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
NanoForge-dev/Engine 的其他 Issue
-
dependencies enhancement good first issue
难度 2/5 1-3 小时 新手友好度 78/100
NanoForge-dev/Engine#513 ·
维护者通常 1 天内回复
-
bug chore tests
难度 2/5 1-3 小时 新手友好度 77/100
NanoForge-dev/Engine#511 ·
维护者通常 1 天内回复
-
docs(network): TSDoc says ICE_SERVERS defaults to an empty list, the code uses public STUN servers未关闭documentation good first issue modules:network
难度 1/5 1 小时以内 新手友好度 88/100
NanoForge-dev/Engine#509 ·
维护者通常 1 天内回复
-
documentation modules:ecs packages:asset packages:core
难度 2/5 1-3 小时 新手友好度 82/100
NanoForge-dev/Engine#508 ·
维护者通常 1 天内回复
-
bug good first issue modules:music modules:sound
难度 2/5 1-3 小时 新手友好度 78/100
NanoForge-dev/Engine#505 ·
维护者通常 1 天内回复
查看 NanoForge-dev/Engine 的全部 Issue
相似的 Issue
-
Mend: dependency security vulnerability
难度 1/5 1-3 小时 新手友好度 65/100
fdm-monster/fdm-monster#5563 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
be-BOP-io-SA/be-BOP#2849 ·
-
难度 2/5 1-3 小时 新手友好度 79/100
维护者通常 1 天内回复
-
1️⃣ phase/under-investigation flaky/confirmed flaky/needs-decision type/bug
难度 2/5 1-3 小时 新手友好度 65/100
growilabs/growi#12246 · 3 条评论 ·
维护者通常 1 天内回复
-
🐛 The Rulekeeper - An index run that gives up on the lock ends Succeeded可能已有人在做 @github-actions 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
SSWConsulting/SSW.Rules#2809 · 1 条评论 ·
维护者通常 1 天内回复