Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 694 Bytes

styleguide.md

File metadata and controls

17 lines (12 loc) · 694 Bytes

Style guide

This document describes agreed-upon conventions for structuring code in this repository, for consistency. Conventions should be added as we determine them.

File naming

  • folders should use lower case and underscores rather than dashes, i.e. missing_data rather than missing-data
  • code notebooks should be named with PascalCase, e.g. MissingMembers.ipynb

Notebooks

  • use Markdown headers where possible to structure the code
  • provide comments to explain the code for public facing notebooks
  • limit any display of data to a few rows so that the notebooks are more readable
  • capitalize Markdown headers, e.g. ## Data Cleaning rather than ## data cleaning