opportunities for more use of validation options
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- frontend
Research direction
Start by reviewing the Validator options mentioned in the issue and comparing their use in core types such as Emitter, Property, NumberProperty, and Vector2Property. Determine which validation options are currently documented or used, then define completion as a documented and agreed set of appropriate validation uses; the issue notes this may be deferred until PhET-iO instrumentation.
Written by the indexing model from the issue text.
Description
Related to #2 (code review);
- Are
Validatorvalidation options (valueType,validValues, etc...) utilized? These are supported in a number of core types likeEmitterandProperty. Is their presence or lack thereof properly documented?
There's good use of range for NumberProperty.
There is no use of valueType or isValidValue, and it looks like there are opportunities for use, specifically for Vector2Property and Property instances.
This issue code be deferred until PhET-iO instrumentation, when it will become more important.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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/normal-modes
-
dev:typescript priority:5-deferred
Difficulty 5/5 Over a week Newbie friendliness 15/100
phetsims/normal-modes#92 ·
-
status:blocks-sim-publication
Difficulty 1/5 Under an hour Newbie friendliness 55/100
phetsims/normal-modes#90 ·
-
dev:code-review
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
phetsims/normal-modes#89 ·
-
priority:5-deferred type:bug type:multitouch
Difficulty 3/5 1-2 days Newbie friendliness 42/100
phetsims/normal-modes#87 · 1 comment ·
-
priority:5-deferred type:performance
Difficulty 3/5 1-2 days Newbie friendliness 42/100
phetsims/normal-modes#84 · 1 comment ·
All issues in phetsims/normal-modes
Similar issues
-
Design only Leadership Survey SLFS
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
bcgov/digital-journeys#2293 ·
-
Toolkit
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
API Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ProjectSidewalk/SidewalkWebpage#5556 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
jessepollak/home#1454 ·
Maintainers usually reply within 1 day
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
opensearch-project/OpenSearch-Dashboards#12822 ·
Maintainers usually reply within 1 day