phetsims / build-a-nucleus

"Build a Nucleus" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
0 stars 5 forks source link

Code Review #165

Closed zepumph closed 1 year ago

zepumph commented 1 year ago

PhET Code-Review Checklist (a.k.a "CRC")

Table of Contents

Specific Instructions

Provide specific instructions here. For example: known problems that will fail CRC items, files that can be skipped, code that is not completed, shared or common code that also needs to be reviewed,... If there are no specific instructions, then delete this section.

GitHub Issues

The following standard GitHub issues should exist. If these issues are missing, or have not been completed, pause code review until the issues have been created and addressed by the responsible dev.

Build and Run Checks

If any of these items fail, pause code review.

Memory Leaks

Performance

Usability

Internationalization

  "material.water": {
    "value": "Water"
  },
  "material.wood": {
    "value": "Wood"
  },
  "shape.block": {
    "value": "Block"
  },
  "shape.cone": {
    "value": "Cone"
  },

Nested substructure is not yet fully supported.

Repository Structure

Coding Conventions

TypeScript Conventions

Math Libraries

IE11

Organization, Readability, and Maintainability

  public constructor( tickMarksVisibleProperty: Property<boolean>,
                      model: Pick<IntroModel, 'changeWaterLevel'>, // <-- Note the call site can pass the whole model, but we declare we will only use this part of it
                      waterCup: WaterCup, modelViewTransform: ModelViewTransform2,
                      providedOptions?: WaterCup3DNodeOptions ) {
cd {{repo}}/js ; wc -l `find . -name "*.ts" -print` | sort

Accessibility

This section may be omitted if the sim has not been instrumented with accessibility features. Accessibility includes various features, not all are always include. Ignore sections that do not apply.

General

Alternative Input

jbphet commented 1 year ago

Code review is complete. Overall the sim seems to be in good shape. The code is well structured and documented, and it's a very cool sim! Back to @Luisav1 and @zepumph for follow up on the issues that were logged during the review and the REVIEW comments that were placed in the code.

zepumph commented 1 year ago

Alright! All review comments have been handled, and the remaining work here is covered by side issues. Thanks @jbphet so much for the thorough and speedy code review. Closing