Skip to content

Style guide

Carolyn Au edited this page Apr 25, 2022 · 2 revisions

We follow the Google code style guides, and enforce lint tests on commits (which can be fixed with ./run_test.sh -f)

Please add appropriate levels of testing, including unit-tests or webdriver tests.

Python / Flask style guide

We follow the Google Python style guide, and automate this with yapf

At a high level:

  • Please add documentation for modules and functions

Typescript / React style guide

We follow the Google Typescript style guide, and automate this with eslint

At a high level:

  • Each component should be in a separate file.
  • Please at least add documentation for:
    • Modules
    • Components
    • Exported functions
    • Interfaces (including comments describing each field)