Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 529 Bytes

File metadata and controls

24 lines (19 loc) · 529 Bytes

coding-conventions

Coding principles

  • TDD
  • DRY
  • meaningful and descriptive names

TODO types

  • TODO
    • MUST have a reference to an open issue (preferably tagged with enhancement)
  • FEATURE
    • MUST have a reference to an open issue (preferably tagged with feature)
  • FIXME
    • MUST have a reference to an open issue (preferably tagged with bug)
  • DOCME
    • Indicates incomplete JavaDoc.
  • TESTME
    • Indicates missing test coverage.
    • Editing might be risky.
  • XXX
    • Something is unclear.