Skip to content
This repository has been archived by the owner on Oct 26, 2023. It is now read-only.

Style Guidelines

Roberto Treviño Cervantes edited this page May 1, 2020 · 1 revision

Naming conventions

For classes, functions and variables (in Python)

  • Avoid using non-trivial abbreviations like "Bkgd" instead of "Background"
  • Use camel case instead of separating with underscores
  • Be explicit with its utility

For file names, javascript, css, html or other non-mission-critical code:

  • Use underscores instead of camel case
  • You are allowed to use abbreviations sparingly to avoid clutter

Styling (for Python)

In general, align to PEP-8 guidelines, and at the end, reformat your code using Black or YAPF with default settings. Also, use the typing module to declare static typing.