Simple guidelines for getting things done, getting along, programming well, and programming in style.
High level guidelines:
- Be consistent.
- Don't rewrite existing code to follow this guide.
- Don't violate a guideline without a good reason.
- A reason is good when you can convince a teammate.
A note on the language:
- "Use" is a positive instruction.
- "Prefer" indicates a better option and its alternative to watch out for.
- "May" indicates optinal, neither good nor bad.
- "Avoid" means don't do it unless you have good reason.
- "Don't" means there's never a good reason.
Thanks to thoughbot for the idea and an example of the guides.
The content is distributed under the Creative Commons Attribution License.