Prince:Coding Guidelines: Difference between revisions
From OpenWetWare
Jump to navigationJump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{PrinceLab}} | {{PrinceLab}} | ||
The most important consideration is to correctly solve the problem at hand. However, your code will become useful beyond the original task as you follow these guidelines: | |||
* Keep it DRY (Don't Repeat Yourself) | * Keep it DRY (Don't Repeat Yourself) | ||
* Write specs for your code (spec-more, bacon, and rspec are good for this) | * Write specs for your code (spec-more, bacon, and rspec are good for this) | ||
| Line 7: | Line 8: | ||
** 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 | ||
* Follow [[Prince:Ruby Best Practices|Ruby Best Practices]] | |||
Latest revision as of 08:44, 24 May 2011
The most important consideration is to correctly solve the problem at hand. However, your code will become useful beyond the original task as you follow these guidelines:
- 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
- Follow Ruby Best Practices
