search

phetsims / curve-fitting

"Curve Fitting" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
6 stars 3 forks source link

review and sign-off for model.md #144

Closed pixelzoom closed 5 years ago

pixelzoom commented 5 years ago

Related to code review https://github.com/phetsims/curve-fitting/issues/143.

In https://github.com/phetsims/curve-fitting/issues/71, I see a discussion between 2 developers about completing model.md and implementation-notes.md. But I can find no paper trial indicating that the lead design (@amanda-phet) reviewed and signed off on model.md. It's typically reviewed by the lead design because the audience for model.md is non-developers, including teachers. This is also typically done before code review, since model.md is one of the first things read by the code reviewer.

See for example https://github.com/phetsims/gas-properties/issues/79, the review and sign-off of model.md for gas-properties.

amanda-phet commented 5 years ago

I forgot to reference this image, but I just deleted one sentence from model.md that was not accurate. The rest looks fine to me.