https://github.com/thoughtbot/guides
A guide for programming in style.
https://github.com/thoughtbot/guides
Last synced: 6 days ago
JSON representation
A guide for programming in style.
- Host: GitHub
- URL: https://github.com/thoughtbot/guides
- Owner: thoughtbot
- Created: 2012-07-27T03:15:44.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T20:05:47.000Z (17 days ago)
- Last Synced: 2025-04-01T18:14:21.684Z (13 days ago)
- Language: Ruby
- Homepage: https://thoughtbot.com/playbook
- Size: 802 KB
- Stars: 9,500
- Watchers: 346
- Forks: 1,375
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- stars - guides
- stars - guides
- my-awesome-github-stars - thoughtbot/guides - A guide for programming in style. (Ruby)
README
# Guides
Guides for working together, getting things done, 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
- "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.
## Guides by category
- [thoughtbot Tech Stack](/tech-stack/)
- [General](/general/)
### Collaboration
- [Code Review](/code-review/)
- [Open Source](/open-source/)
- [Product Review](/product-review/)
### Protocols
- [Accessibility](/accessibility/)
- [Data](/data/)
- [Email](/email/)
- [Object-Oriented Design](/object-oriented-design/)
- [Security](/security/)
- [Web](/web/)
- [Web Performance](/web-performance/)
### Languages
- [Bash](/bash/)
- [CSS](/css/)
- [Elixir](/elixir/)
- [ERB](/erb/)
- [HAML](/haml/)
- [Haskell](/haskell/)
- [HTML](/html/)
- [Java](/java/)
- [JavaScript](/javascript/)
- [Objective-C](/objective-c/)
- [Python](/python/)
- [Ruby](/ruby/)
- [Sass](/sass/)
- [Scala](/scala/)
- [Shell](/shell/)
- [Swift](/swift/)
- [TypeScript](/typescript/)
### Frameworks and platforms
- [Android](/android/)
- [Ember](/ember/)
- [iOS](/ios/)
- [Rails](/rails/)
- [React](/react/)
- [React Native](/react-native/)
- [Testing with Jest](/testing-jest/)
- [Testing with RSpec](/testing-rspec/)
### Tools
- [Git](/git/)
- [GraphQL](/graphql/)
- [Postgres](/postgres/)
- [Relational Databases](/relational-databases/)
## Contributing
Please read the [contribution guidelines](/CONTRIBUTING.md) 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**.
## Credits
Thank you,
[contributors](https://github.com/thoughtbot/guides/graphs/contributors)!
## License
Guides is © 2020-2025 thoughtbot, inc. It is distributed under the [Creative
Commons Attribution License](http://creativecommons.org/licenses/by/3.0/).
## About thoughtbot
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][community].
We are [available for hire][hire].
[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com/hire-us?utm_source=github