UtteranceQueue implementAsSkeleton is an anti-pattern
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- accessibility
Research direction
Start by reading the UtteranceQueue implementation, especially implementAsSkeleton, and issue #17 for context. Check whether the skeleton is referenced by runtime or API validation; done means removing this implementation detail without changing the published UtteranceQueue API or behavior.
Written by the indexing model from the issue text.
Description
While working on https://github.com/phetsims/utterance-queue/issues/17, I'm pretty sure that we could get rid of this confusing implementation detail in UtteranceQueue (a remnant of baseline API files for PhET-iO). I don't think there is anything checking the runtime against what is expected to be in it. This shouldn't even be an API change, since the sims being published with description are the only ones that should have an UtteranceQueue.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from phetsims/utterance-queue
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
phetsims/utterance-queue#125 ·
-
phetsims/utterance-queue#122 · 2 comments · 1 assignee ·
-
phetsims/utterance-queue#121 · 1 assignee ·
-
Remove addToFront Open
phetsims/utterance-queue#120 · 1 assignee ·
-
dev:voicing type:i18n
Difficulty 5/5 Over a week Newbie friendliness 25/100
phetsims/utterance-queue#119 · 1 comment ·
All issues in phetsims/utterance-queue
Similar issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Crush Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ElementsProject/cln-application#167 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Quantco/pnpm-licenses#17 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100