Skip to content

Commit

Permalink
Update docs and revise TODO, see phetsims/scenery-phet#686 and phetsi…
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Jul 19, 2021
1 parent e1f11e0 commit cd910d1
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions checklists/code_review_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,10 @@ For a sim repository named “my-repo”, the general structure should look like
- [ ] Does `implementation-notes.md` adequately describe the implementation, with an overview that will be useful to future maintainers?
- [ ] Sim-specific query parameters (if any) should be identified and documented in one .js file in js/common/ or js/ (if there is no common/). The .js file should be named `{{PREFIX}}QueryParameters.js`, for example ArithmeticQueryParameters.js for the aritmetic repository, or FBQueryParameters.js for Function Builder (where the `FB` prefix is used).
- [ ] Query parameters that are public-facing should be identified using `public: true` in the schema.
- [ ] All sims should use a color file named MyRepoColors.js or, if using abbreviations, MRColors.js, and use
- [ ] All sims should use a color file named MyRepoColorProfile.js or, if using abbreviations, MRColorProfile.js, and use
ProfileColorProperty where appropriate, even if they have a single (default) profile. See https://github.com/phetsims/scenery-phet/issues/642
and https://github.com/phetsims/scenery-phet/issues/515
and https://github.com/phetsims/scenery-phet/issues/515. Please see gas-properties/js/common/GasPropertiesColorProfile.js
for a good example.

## **Coding Conventions**

Expand Down

0 comments on commit cd910d1

Please sign in to comment.