From 5ae7985a9f1e19499086e35a5594a12b6f5876bd Mon Sep 17 00:00:00 2001 From: samreid Date: Mon, 19 Jul 2021 15:45:43 -0600 Subject: [PATCH] Update docs and revise TODO, see https://github.com/phetsims/scenery-phet/issues/686 and https://github.com/phetsims/scenery-phet/issues/515 --- checklists/code_review_checklist.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/checklists/code_review_checklist.md b/checklists/code_review_checklist.md index 8e6b5d9e..1d6d7fd0 100644 --- a/checklists/code_review_checklist.md +++ b/checklists/code_review_checklist.md @@ -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**