Prince:Coding Guidelines

From OpenWetWare
Revision as of 13:49, 12 January 2011 by John T. Prince (talk | contribs)
Jump to navigationJump to search

Home        Lab Members         Research         Publications         Internal         Mass Spec         Contact        


  • Keep it DRY (Don't Repeat Yourself)
  • Write specs for your code (spec-more, bacon, and rspec are good for this)
  • Code should be self documenting
  • Code should also be documented, to be clear
    • YARDoc is the preferred tool, then TomDoc
  • Follow semantic versioning practices