Prince:Coding Guidelines: Difference between revisions
From OpenWetWare
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
* Keep it DRY (Don't Repeat Yourself) | * Keep it DRY (Don't Repeat Yourself) | ||
* Write specs for your code (spec-more and bacon are good for this) | * Write specs for your code (spec-more and bacon 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 | |||
Revision as of 16:16, 16 August 2010
- Keep it DRY (Don't Repeat Yourself)
- Write specs for your code (spec-more and bacon 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
