Guides

Guides for getting things done, programming well, and programming in style.

• Style

High level guidelines:

• Be consitent.
• 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:

• "Avoid" means don't do it unless you have good reason.
• "Don't" means there's never a good reason.
• "Prefer" indicates a better option and its alternative to watch out for.
• "Use" is a positive instruction.

Credits

Guides is maintained by netflower Ltd. & Co. KG.

It is largely inspired by thoughtbot's guides, The Ruby Style Guide and the GitHub Styleguide.

License

Guides is © 2014 netflower Ltd. & Co. KG. It is distributed under the Creative Commons Attribution License.