Guides for getting things done, programming well, and programming in style.
You can see GitBook version on https://www.gitbook.com/book/ookami/guides/details.
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.
Please read the contribution guidelines before submitting a pull request.
In particular: if you have commit access, please don't merge changes without waiting a week for everybody to leave feedback.
Thank you, thoughtbot and all the contributors!
The original Guides is maintained by thoughtbot, inc.
ookamiinc/guides is maintained by ookami, Inc.
This Guides repository is a derivative of "Guides" by thoughtbot, used under CC BY.
ookamiinc/guides is licensed under CC BY by ookami, Inc.
The names and logos for ookami are trademarks of ookami, Inc.