Guides for working together, getting things done, programming well, and programming in style.
- 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.
- "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.
- Bash
- CoffeeScript
- CSS
- Elixir
- ERB
- HAML
- Handlebars
- Haskell
- HTML
- Java
- JavaScript
- Objective-C
- Python
- Ruby
- Sass
- Scala
- Shell
- Swift
- TypeScript
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, contributors!
Guides is Β© 2020-2024 thoughtbot, inc. It is distributed under the Creative Commons Attribution License.
This repo is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
We love open source software! See our other projects. We are available for hire.