phetsims / phetsims/binder

Add data about each component

Open
#6 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
0
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Related to #5, the style guide show this information which is not presented in the binder view at the moment:

Here is additional information from the Style Guide that we should add to the document:

  • Number of published sims with component: [number]
  • Sims with component (not necessarily published): [list of all sim repos]
  • Published sims with component: [list of sim links]
  • Published sims with element a11y enabled: [list of sim links]

@zepumph can you work on that part? You should be able to leverage the existing data for the first two bullets, and I think you referred to some metadata service that would help with the latter two.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the binder view and the related issue #5, then trace the existing component data and the metadata service referenced in the issue. The work is done when the document includes counts and lists for all four requested categories, including published sims and published sims with element accessibility enabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.