Closed ariel-phet closed 6 years ago
Note to self: I've finished reviewing the code in the common
subdirectory, pick it back up in manual-gene-expression
for the next round.
Assigning to @ariel-phet to determine what to do next on this issue.
Assigning to myself to make sure that last few items are done during the publication phase.
All items complete, version 1.0 has been published. Closing.
PhET code-review checklist
Build and Run Checks
Repository structure
[x] Are all required files and directories present?
For a sim repository named “my-repo”, the general structure should look like this (where audio/ or images/ may be omitted if the sim doesn’t have those types of assets).
For a common-code repository, the structure is similar, but some of the files and directories may not be present if the repo doesn’t have audio, images, strings, or a demo application.
[x] Is the js/ directory properly structured?
All JavaScript source should be in the js/ directory. There should be a subdirectory for each screen (this also applies for single-screen sims). For a multi-screen sim, code shared by 2 or more screens should be in a js/common/ subdirectory. Model and view code should be in model/ and view/ subdirectories for each screen and common/. For example, for a sim with screens “Introduction” and “Custom”, the general directory structure should look like this:
grunt generate-published-README.md
?chipper/js/grunt/Gruntfile.js
?Coding conventions
Documentation
Organization, Readability, Maintainability
Performance, Usability
Memory Leaks
tandem.addInstance
should be accompanied bytandem.removeInstance
or documented why removeInstance is unnecessary. N/A - sim is not instrumented at this point