Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 1.63 KB

the_rules.md

File metadata and controls

34 lines (29 loc) · 1.63 KB

10 Commandments of Bioinformatics

In random order

Developers

  1. Thou shalt use an open source licence
  2. thou shalt use version control and version number significant releases
  3. thou shalt not use hard-coded paths or filenames.. ever
  4. thou shalt have tests
  5. tho shalt not write redundant software (e.g., another short read aligner)
  6. thou shalt not fail silently
  7. though shalt not create empty files if you fail (including files with just column headins in)
  8. thou shalt not put weird characters in filenames or paths, including spaces
  9. Tho shalt use --help and not -help
  10. thou shalt have documentation, including a 'getting started' section
  11. thou shalt generate neatly organised output directory heirarchies
  12. thou shalt not invent new file formats
  13. thou shalt not frivolously implement a parser
  14. thou shalt work with gzipped files
  15. thou shall build checkpoints into long running software?
  16. tho shal not write 129869 temprary files (Trinity)

Users

  1. thou shalt use version control for all coding work
  2. Thou shalt not publish a paper that use "in-house (Language X) scripts, available upon request"
  3. thou shalt RTFM first.
  4. Thou shalt not use massively outdated versions of actively maintained software
  5. thou shalt log everything, including paths to executables, versions, environmental variables, the lot.
  6. though shalt always resolve all input paths and filenames to absolute paths before doing anything else
  7. thou shalt not put weird characters in filenames or paths, including spaces
  8. thy plots shall be vector pdfs or svgs, never bitmaps
  9. Thou shalt verify input before submitting a bug report.