Prince:Coding Guidelines: Difference between revisions
From OpenWetWare
Jump to navigationJump to search
No edit summary |
mNo edit summary |
||
Line 2: | Line 2: | ||
* Keep it DRY (Don't Repeat Yourself) | * Keep it DRY (Don't Repeat Yourself) | ||
* Write specs for your code (spec-more and | * Write specs for your code (spec-more, bacon, and rspec are good for this) | ||
* Code should be self documenting | * Code should be self documenting | ||
* Code should also be documented, to be clear | * Code should also be documented, to be clear | ||
** YARDoc is the preferred tool, then TomDoc | ** YARDoc is the preferred tool, then TomDoc | ||
* Follow [http://semver.org/ semantic versioning] practices | * Follow [http://semver.org/ semantic versioning] practices |
Revision as of 13:49, 12 January 2011
- 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