platanus/guides

guides!

Guides to be happy developers ;)

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

• Protocol
  • Git
  • Open Source
  • Tinytalks
• Code Review
• Best Practices
• Style
• Cheat Sheets
  • Hub
• Playbook
  • Investment Day
• Toolbelt

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:

• "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.

IMPORTANT: Rememeber to watch this repo!

Credits

Thank's to the guys of Thoughbot for the idea and the base guides. Also special thanks to all our own contributors!

Guides is maintained by platanus.

License

Guides is © 2014 platanus, spa. It is distributed under the Creative Commons Attribution License.

The names and logos for platanus are trademarks of platanus, inc.