docs(sound): READMEs do not say that sound and music start muted
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 20/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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?
- Lenguaje dominante
- TypeScript
- Estrellas
- 7
- Forks
- 2
- Merge medio
- 1 d 17 h
- PR fusionados (30 d)
- 17
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NanoForge-dev/Engine
-
dependencies enhancement good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NanoForge-dev/Engine#513 ·
Los mantenedores suelen responder en 1 día
-
bug chore tests
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
NanoForge-dev/Engine#511 ·
Los mantenedores suelen responder en 1 día
-
docs(network): TSDoc says ICE_SERVERS defaults to an empty list, the code uses public STUN serversAbiertodocumentation good first issue modules:network
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
NanoForge-dev/Engine#509 ·
Los mantenedores suelen responder en 1 día
-
documentation modules:ecs packages:asset packages:core
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
NanoForge-dev/Engine#508 ·
Los mantenedores suelen responder en 1 día
-
bug good first issue modules:music modules:sound
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NanoForge-dev/Engine#505 ·
Los mantenedores suelen responder en 1 día
Todos los issues de NanoForge-dev/Engine
Issues similares
-
Mend: dependency security vulnerability
Dificultad 1/5 1-3 horas Aptitud para principiantes 65/100
fdm-monster/fdm-monster#5563 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
be-BOP-io-SA/be-BOP#2849 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 79/100
Los mantenedores suelen responder en 1 día
-
1️⃣ phase/under-investigation flaky/confirmed flaky/needs-decision type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
growilabs/growi#12246 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
🐛 The Rulekeeper - An index run that gives up on the lock ends SucceededPosiblemente ocupada @github-actions la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
SSWConsulting/SSW.Rules#2809 · 1 comentario ·
Los mantenedores suelen responder en 1 día