Ruby Style Guide

Airbnb's Ruby Style Guide
By Jason Katz-Brown

This is Airbnb's Ruby Style Guide.

It was inspired by Github's guide and Bozhidar Batsov's guide.

Table of Contents

  1. Whitespace

    1. Indentation
    2. Inline
    3. Newlines
  2. Line Length
  3. Commenting

    1. File/class-level comments
    2. Function comments
    3. Block and inline comments
    4. Punctuation, spelling, and grammar
    5. TODO comments
    6. Commented-out code
  4. Methods

    1. Method definitions
    2. Method calls
  5. Conditional Expressions

    1. Conditional keywords
    2. Ternary operator
  6. Syntax
  7. Naming
  8. Classes
  9. Exceptions
  10. Collections
  11. Strings
  12. Regular Expressions
  13. Percent Literals
  14. Rails Specific
  15. Be Consistent

Be Consistent

If you're editing code, take a few minutes to look at the code around you and determine its style. If they use spaces around all their arithmetic operators, you should too. If their comments have little boxes of hash marks around them, make your comments have little boxes of hash marks around them too.

The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you're saying rather than on how you're saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to read it. Avoid this.

Google C++ Style Guide