Marking issues as: "good-first-issue", "help-wanted", and "beginner-friendly"

[marlitas]

This issue will track and link issues in phetsims common code repos that we believe are good candidates for open source contributions.

[marlitas]

In Scenery:

"good-first-issue":

• - Should Node visibleProperty be IReadOnlyProperty<boolean> ? phetsims/scenery#1363
• - brighterColor fails if any RGB component of the target Color is 0. phetsims/scenery#1262

"beginner-friendly":

• - ParallelDOM.js uses at least 8 different names for "primary sibling" phetsims/scenery#1231
• - Better documentation for how to find scenery's accessibility documentation. phetsims/scenery#1208
• - Rename many ParallelDOM options to be more clear phetsims/scenery#1203
• - TODOs in this repo should point to useful github issues phetsims/scenery#1581
• - separate or rename scenery.Util phetsims/scenery#64

"help-wanted":

• clean up Node's 'on' method phetsims/scenery#904

[marlitas]

Joist

"good-first-issue":

• - Move backgroundColor from Screen to ScreenView phetsims/joist#807
• - NavigationBarScreenButton doesn't extend JoistButton phetsims/joist#273 (this needs some more breakdown and specificity though)

"help-wanted":

• - Navigation Bar Screen Icon Text should float down or be centered on the midline phetsims/joist#732
• - Duplicated code between AboutDialog and UpdateDialog phetsims/joist#557
• - Remove jquery phetsims/joist#537
• - Add volume control to the sim sounds phetsims/joist#931 (this seems like it would be straightforward to implement but needs a designer...)

[marlitas]

Sun

"help-wanted":

• Specify params for Popupable trait without using any phetsims/sun#777
• use nested options for appearance strategies phetsims/sun#653
• Consider moving Molecule Shapes TitledPanel into Sun phetsims/sun#200

"good-first-issue":

• - Address TODO about propagating options to button model. phetsims/sun#749
• - factor out button shape from sun buttons phetsims/sun#659
• - convert sims to use AquaRadioButtonGroup phetsims/sun#555 (this chipaway needs to be triaged and also clarify what would be expected form a contributor)
• - unify radio button group implementations phetsims/sun#523 (this is another contender that needs more clarity, and also removing the instructions related to PhET-iO)
• - VSlider should flip trackSize and thumbSize phetsims/sun#522
• - Visual appearance of rectangular buttons phetsims/sun#351

[marlitas]

Axon

"good-first-issue":

• - Eliminate unused or unnecessary ObservableArray methods from ObservableArrayDef phetsims/axon#334

"help-wanted":

• - Separate BidirectionalDynamicProperty from DynamicProperty phetsims/axon#410
• - duplicate code and erroneous doc in Multilink and DerivedProperty phetsims/axon#41

[marlitas]

Kite

"beginner-friendly":

• 98 TODO comments in kite phetsims/kite#76
• rectangle with 2 rounded corners phetsims/kite#56 (It would be easy to simplify the instructions here for a beginner to feel comfortable, but as is right now doesn't feel beginner-friendly).

[marlitas]

Tambo

"good-first-issue":

• Remove unused sounds, iteration 1 phetsims/tambo#87

[marlitas]

Dot

"beginner-friendly":

• 57 TODO comments in dot phetsims/dot#96

"good-first-issue":

• Add JSDoc for all methods and bring documentation up to PhET standards phetsims/dot#49
• add visibility annotations phetsims/dot#38

"help-wanted":

• separate or rename dot.Util phetsims/dot#4 (I would want to check in with devs on this before opening it up... it has the potential to be an open source chipaway, but I feel like we just haven't made a decision on what we want. It's also incredibly old)

[marlitas]

This is my first pass at identifying some issues. I tried to stay away from things that really involved or interacted directly with phet-io. Many will need a clear summary or explanation of next steps for someone to feel confident going into it.

My next steps will be to triage these again and add labels.

@brettfiedler are there any other common-code repos you would like me to hit that are missing here? I did: Scenery, Joist, Sun, Axon, Kite, Tambo, and Dot

[marlitas]

Issues that need outside input or additional work before they are ready for the public:

• separate or rename scenery.Util phetsims/scenery#64 (This needs dev input to determine which way we want to go.)
• convert sims to use AquaRadioButtonGroup phetsims/sun#555 (this chipaway needs to be triaged and also clarify what would be expected form a contributor)
• unify radio button group implementations phetsims/sun#523 (this is another contender that needs more clarity, and also removing the instructions related to PhET-iO)
• Add volume control to the sim sounds phetsims/joist#931 (this seems like it would be straightforward to implement but needs a designer...)
• separate or rename dot.Util phetsims/dot#4 (I would want to check in with devs on this before opening it up... it has the potential to be an open source chipaway, but I feel like we just haven't made a decision on what we want. It's also incredibly old)

[marlitas]

Over to @brettfiedler for next steps.

EDIT: I can't assign anyone, so you'll have to assign yourself?

[zepumph]

I love these new labels. Thanks for doing this. I found this issue while adding labels to a new repo, and had a couple thoughts here.

• I was noticing that they don't adhere to our github label conventions, in which they get a prefixed "class" with a colon. Perhaps all of these could be added to type:XX? Or maybe community: or pose: if we want something new and specific to POSE. Not sure what is best, but organization sounds preferable given the complexity and size of our label system.
• I also wanted to note that we already have dev:help-wanted, perhaps we should get rid of that label, and make all of those labels have this label? Not sure what's best.
• It doesn't look like this was added to all repos consistently, For example phetcommon doesn't have these labels, but it is in the github label system in phet-info, so when I added "all labels to new repo" over in Add github labels to this repo phetsims/soccer-common#5, it did pick up these labels. I think that keeping consistent labels in every single repo (unless we need a label for one specific repo, like we have in chipper) is best.

[marlitas]

@zepumph The reason they are not prefixed with a colon is because we want these labels to be picked up by github as "goog-first-issue", "help-wanted", etc. that they market to github users. Generally github has a list of issues from different open source projects that have these labels for those that may want to contribute to those projects. Adding a prefix would break this for us and our issues would no longer be bundled in there which would be very un-POSE like of us.

I also wanted to note that we already have dev:help-wanted, perhaps we should get rid of that label, and make all of those labels have this label? Not sure what's best.

That label has been used (i know by me and SR) to communicate when we might need help from another PhET dev on an issue. We used this alot for CAV. I did not eliminate it because those types of issues should not get mixed into the POSE "help-wanted" issues.

I think that keeping consistent labels in every single repo is best.

I'm fine with this. @brettfiedler would you like me to add these to every single repo?