search

phetsims / number-compare

"Number Compare" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
0 stars 0 forks source link

model.md and implementation-notes.md #15

Open pixelzoom opened 1 year ago

pixelzoom commented 1 year ago

model.md and implementation-notes.md need to be written.

Both of these files currently look like they were copied from number-play. Imo, that's worse than having empty files. So I'm going to wipe them clean.

pixelzoom commented 1 year ago

I'm not sure if this issue blocks publication. I know that there is work going on elsewhere that intends to make model.md a more consistent "deliverable" with sims. I can't find the issue, and don't know if it applies to all brands, or just for PhET-iO. Check with @arouinfar.

arouinfar commented 1 year ago

In https://github.com/phetsims/phet-io-sim-specific/issues/20 we decided to link to model.md in the general PhET-iO Guide. This requires all phet-io-brand sims have a model.md, which I thought was a relatively safe assumption. Isn't it a part of the code review checklist to make sure every sim has a model.md?

For derivative sims, like ph-scale-basics, I think it's reasonable to link back to the main sim's model.md, but the file should still exist.

pixelzoom commented 1 year ago

Thanks @arouinfar. Yes, completing model.md is indeed part of the code-review checklist. But for this suite of sims (Number Play, Number Compare) we're deferring some of the code-review requirements in the interest of publishing ASAP. Since these publications will not include PhET-iO, it sounds like deferring the completion of model.md will not be an issue.

chrisklus commented 1 year ago

@amanda-phet and I are working on these in google docs!