Molarity - Master A11y Publication Checklist

[emily-phet]

• @emily-phet "sign off" (2019 Quarter 4)
  • Performance acceptable
  • (Status unknown, moving on) Carefully review ?showPointerAreas
  • No new feature requests
• Pre-publication items
  • Main screenshot updated
  • Create issue for updating Teacher Guide (Update Teacher Guide, Molarity will be published soon #220)
  • Create issue for updating Sound Feature Video (Molarity Sound Features Video Script and Recording #221)
    • Sound Feature Video created/published
  • Verify credits
  • Issue created to Update sim page credits to (Update Sim page credits #228)
  • Finalize design docs
    • Interactive Description design doc (Update Interactive Description Design Doc #227)
    • Sound design doc
• Create issue to do email announcement and Twitter announcement written, sent AP/ON (Date: / / ) (Create Social Media post for Molarity #225)
• Post-publication items
• Add the simulation to responsible_dev.md
• Hold postmortem if applicable (Date: 03/02/2020)

Implementation

• Repository created (Date: / /)
• simula-rasa used to create project skeleton
• README.md created using grunt unpublished-readme
• Collaborators added (such as QA team, designers, etc)
• standard GitHub label set applied
• repository added to chipper/data/ files
• Development started (Date: 01/29/2019 )
• Sound implementation in sim using Tambo complete (Date: 07/08/2019 by JB )
• Sim is "feature complete" (Date: 11/25/19)
• Preparation of code for code review completed (Date: 08/29/19 by TW)
• Code review (likely by responsible dev) completed (Date: 12/10/19)
• Update implementation notes with a11y/description specific documentation (Date: 9/24/19)
• Published (Date: 2/17/20)
• README.md updated using grunt published-readme (in master and release branch)

QA

• Dev testing started (Date: 10/07/2019)
• Dev testing completed (Date: 10/10/2019)
• First RC published (Date: 12/18/2019)
• Test matrices put in Testing Matrices Folder
• RC testing completed (Date: 2/14/20)
  • RC Test - RC Test: Molarity 1.5.0-rc.1 qa#464 completed (Jan 8, 2020)
  • RC Test 1.5.0-rc.3 - RC Test: Molarity 1.5.0-rc.3 qa#476 (closed Feb 10, 2020)

Published with interactive description (regular and mobile), sound effects and sonification, and alternative input - 2/17/2020

[emily-phet]

I just had a meeting with @jessegreenberg and @zepumph, and one of the topics I brought up was a walk-through of a potentially desirable workflow for Molarity. I wanted to share what came out of the conversation with everyone - see below.

• (MM and TW) Finalizing design/implementation (this is the stage we’re in now, ironing out the remaining kinks for design and implementation)
• (TW, with support as needed!) Preparation of code for code review - there’s a handy dandy checklist for this.
• Perhaps MK or JG is a good person to do code review? If not, will need to check in with Ariel about who might do this in advance to get this on their plate.
• (??) Code review

(JB) Implement sound in sim with Tambo (can happen in parallel with TW’s work listed above, just coordinate so as not to... step on each others code).

• (TW to lead, with support as needed) Dev test, address issues, iterate as needed
• (TW to lead, with support as needed) RC test, address issues, iterate as needed
• (TW) Publish!

Just as I was going to send this info as an email, it occurred to me that it might be useful to have this as a GitHub list, and of course (!) there is something similar that existed and had been adapted by @terracoda. So, I adapted it further for the list above. Please feel free to edit the list above as needed to make it more accurate and helpful. My hope is that this can serve as a useful tool for @twant and @Matthew-phet as they take their first sim to the finish line. :)

[pixelzoom]

Should "responsible developer" code review be somewhere on this checklist?

[zepumph]

To that seems like the obvious first choice, but it feels like a code review could be done by anyone so long as all parties are aware and agreed on it. I edited it above.

[pixelzoom]

It's not that I have a burning desire to do a code review :) But the responsible developer is presumably most familiar with the sim. And I think it's important for the responsible developer to keep current on what other developers are doing in the code that they're responsible for.

Also related to this checklist and publication... There are some non-A11y issues/changes that will be picked up as part of any publication that happens. So we should also discuss who sheperds the sim through the RC and publication process. That has typically been the responsible developer.

[ariel-phet]

@emily-phet @pixelzoom @zepumph I think it is totally appropriately for the responsible dev to be the code reviewer, and in case like this help shepherd the sim to publication (they don't need to be doing the publication work, but just helping avoid pitfalls and such).

[emily-phet]

The intention was not to exclude the responsible dev, rather - to not obligate the responsible dev. Their may be situations where the responsible dev is not available or would prefer not to do the code review, especially as we just keep making more and more sims!

@pixelzoom you are of course welcome to code review this sim! We'll keep you in the loop as @twant gets ready for that step.

[zepumph]

@twant please feel free to fill in dates and check boxes above as things are finished. Let me know if I can help at all.

[terracoda]

@emily-phet and @jessegreenberg, I am not sure what to do with this issue. It's a bit different than the A11y Features checklist. I added the date for the completion of the first RC Test (phetsims/qa#464). I think the sim is getting close to publication.

[emily-phet]

@terracoda Can you create issues for updating the Teacher Guide (assign to Brett and Amy) and for creating a sound features video (assign to Brett)? That's some of the remaining unchecked checkboxes at the top of the list above.

[jessegreenberg]

@emily-phet Molarity 1.5.0 has been published, does anything else need to be checked off here?

[emily-phet]

@jessegreenberg
Wonderful news!
Let's hold a post-mortem (I'll send out a slack message on this) and then we can make some tweaks to this checklist (e.g., editing or completing the unchecked options above).

[emily-phet]

Issues have been created for all remaining checklist items above that we will be addressing. Please close this once all related issues are closed.

[terracoda]

Please re-assign me if I am supposed to focus on this issue.

[zepumph]

It looks like @BLFiedler and @Matthew-Moore240 are assigned to the outstanding issues, can this issue be closed and taken up in those side issues?

[terracoda]

I re-worded the unchecked items, so to be "create issue to..." that way I could check them, and those issues can be followed up in those issues. I think that is a good strategy going forward.

All things are checked and issues are made for undone items, so closing.