Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 1.14 KB

code_standards.rst

File metadata and controls

23 lines (20 loc) · 1.14 KB
Raw

Code Standards

  • We are trying to keep our own code entirely written in Python.
  • PUDL should work on Linux, Mac OS X, or Windows -- don't hard code anything that is platform specific, unless you make it work for all platforms.
  • Intent is only to support the most recent actively used version or two of Python (Currently Python 3.7).
  • Assuming that most if not all users will be using conda to maanage their Python software environment.
  • Make sure the tests run locally, including the linters. See testing for more information.
  • Don't decrease the overall test coverage -- if you introduce new code it also needs to be exercised by the tests. See testing for details.
  • Write good docstrings, using the Google docstring format.
  • PUDL should work for use in application development or for interactive analysis (e.g. Jupyter Notebooks).
  • dev_setup
  • testing