Skip to content

CodingStandards

Jump to bottom Edit New page
Rob Smith edited this page Jul 13, 2012 · 4 revisions

Coding Standards

Current

  • Collector default configuration should be in the get_default_config method of the class
  • All collectors should verify before doing. For example, if the collector requires the existance of a file, check to verify that it exists and is readable before opening.
  • Unit tests are highly recommended
  • PEP-8
  • Documentation should be done docstr style at the start of the collector. This is how we generate the wiki
Add a custom footer
Add a custom sidebar
Clone this wiki locally