Skip to content

Latest commit

 

History

History
10 lines (9 loc) · 558 Bytes

File metadata and controls

10 lines (9 loc) · 558 Bytes

General Guidelines and Coding Standards

  1. All functions should have doc-strings and type hints. Doc strings should follow the Sphinx ReadTheDocs style (eg :param some_param: This is a parameter etc..)
  2. When uncertain ask clarifying questions.
  3. Before making large changes form a plan and ask user for approval.
  4. Code should be modular and testable.
  5. Refrain from excessive try except blocks. These should only be used in limited circumstances.

Project Context

See README.md for full project overview, architecture, and data sources.