Skip to content

Commit

Permalink
update doc and support auto format, phetsims/density-buoyancy-common#45
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Kauzmann <michael.kauzmann@colorado.edu>
  • Loading branch information
zepumph committed Mar 26, 2024
1 parent 88e0a04 commit 9a96b60
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions checklists/code-review-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,9 @@ If any of these items fail, pause code review.
code repos can have custom README files.
- [ ] Is the LICENSE file correct? (Generally GPL v3 for sims and MIT for common code,
see [this thread](https://github.com/phetsims/tasks/issues/875#issuecomment-312168646) for additional information).
Note that "common" repos that are mostly sim-specific code (like circuit-construction-kit-common and
density-buoyancy-common) should be GPL v3,
see [other thread](https://github.com/phetsims/density-buoyancy-common/issues/45).
- [ ] Does .gitignore match the one in simula-rasa?
- [ ] In GitHub, verify that all non-release branches have an associated issue that describes their purpose.
- [ ] Are there any GitHub branches that are no longer needed and should be deleted?
Expand All @@ -230,8 +233,8 @@ If any of these items fail, pause code review.
should be set via a query parameter from `{{PREFIX}}QueryParameters.js`.
- [ ] Does `package.json` refer to any dependencies that are not used by the sim?
- [ ] Does `package.json` include any config that was only needed for development? For example:
* Lint rules turned off or made more graceful
* Certain testing or simFeatures turned off with flags
* Lint rules turned off or made more graceful
* Certain testing or simFeatures turned off with flags

## **Coding Conventions**

Expand Down Expand Up @@ -274,10 +277,12 @@ If any of these items fail, pause code review.
decouple by narrowing the API using `Pick`, but this is a bit of a hack. Here's an example:

```ts
class MyClass {
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 ) {
providedOptions?: WaterCup3DNodeOptions ) {}
}
```

- [ ] Is there too much unnecessary decoupling? (e.g. by passing all of the properties of an object independently
Expand Down

0 comments on commit 9a96b60

Please sign in to comment.