Skip to content

Commit

Permalink
Update code review checklist about casing based on discussion with @p…
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Aug 11, 2021
1 parent dea0f05 commit aaba76e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion checklists/code_review_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,10 @@ Use your judgment!

- [ ] Are `Validator` validation options (`valueType`, `validValues`, etc...) utilized? These are supported in a number of core types like `Emitter` and `Property`. Is their presence or lack thereof properly documented?

- [ ] Files should be named like `CapitalizedCamelCasing.js` when returning a constructor, or `lowerCaseCamelCasing.js` when returning a non-constructor function or singleton. When returning a constructor or singleton, the constructor name should match the filename.
- [ ] Files should be named like `CapitalizedCamelCasing.js` when returning a constructor, or `lowerCaseCamelCasing.js`
when returning a non-constructor function or singleton. When returning a constructor or singleton, the constructor name
should match the filename. Where singletons are treated like classes with static attributes (like SimulaRasaConstants or SimulaRasaColors),
uppercase should be used.

- [ ] Assertions should be used appropriately and consistently. Type checking should not just be done in code comments. Use `Array.isArray` to type check an array.

Expand Down

0 comments on commit aaba76e

Please sign in to comment.