Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
samples
README.md

README.md

Style

A guide for programming in style.

High level guidelines:

  • Be consistent.
  • Don't rewrite existing code to follow this guide.
  • Don't violate the conventions without a good reason.

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.

Git

  • Avoid including files in source control that are specific to your development machine or process.
  • Delete local and remote feature branches after merging.
  • Perform work in a feature branch.
  • Prefix feature branch names with your initials.
  • Rebase frequently to incorporate upstream changes.
  • Use a pull request for code reviews.
  • Write a good commit message.

Formatting

  • Avoid inline comments.
  • Break long lines after 80 characters.
  • Delete trailing whitespace.
  • Don't include spaces after (, [ or before ], ).
  • Don't vertically align tokens on consecutive lines.
  • If you break up an argument list, keep the arguments on their own lines and closing parenthesis on its own line.
  • If you break up a hash, keep the elements on their own lines and closing curly brace on its own line.
  • Indent continued lines two spaces.
  • Indent private methods equal to public methods.
  • Use 2 space indentation (no tabs).
  • Use an empty line between methods.
  • Use spaces around operators, after commas, after colons and semicolons, around { and before }.
  • Don't misspell.
  • Use Unix-style line endings (\n).

Naming

  • Avoid abbreviations.
  • Avoid types in names (user_array).
  • Name the enumeration parameter the singular of the collection.
  • Name variables, methods, and classes to reveal intent.
  • Treat acronyms as words in names (XmlHttpRequest not XMLHTTPRequest), even if the acronym is the entire name (class Html not class HTML).
  • Name variables holding a factory with _factory (user_factory).
  • Name variables created by a factory after the factory (user_factory creates user).

CSS

  • Order properties within rule sets alphabetically.

JavaScript

  • Use CoffeeScript.

CoffeeScript

  • Initialize arrays using [].
  • Initialize empty objects and hashes using {}.
  • Use CamelCase for classes, mixedCase for variables and functions, SCREAMING_SNAKE_CASE for constants, _single_leading_underscore for private variables and functions.

Ruby

Sample

  • Avoid conditional modifiers (lines that end with conditionals).
  • Avoid ternary operators (boolean ? true : false). Use multi-line if instead to emphasize code branches.
  • Define the project's Ruby version in the Gemfile.
  • Prefer detect over find.
  • Prefer inject over reduce.
  • Prefer map over collect.
  • Prefer select over find_all.
  • Prefer single quotes for strings.
  • Use _ for unused block parameters.
  • Use %{} for single-line strings needing interpolation and double-quotes.
  • Use && and || for Boolean expressions.
  • Use {...} for single-line blocks. Use do..end for multi-line blocks.
  • Use ? suffix for predicate methods.
  • Use CamelCase for classes and modules, snake_case for variables and methods, SCREAMING_SNAKE_CASE for constants.
  • Use def self.method, not def Class.method or class << self.
  • Use def with parentheses when there are arguments.
  • Use each, not for, for iteration.
  • Use heredocs for multi-line strings.

ERb

Sample

  • When wrapping long lines, keep the method name on the same line as the ERb. interpolation operator and keep each method argument on its own line.

Rails

  • Avoid member and collection routes.
  • Avoid the :except option in routes.
  • Don't reference a model class directly from a view.
  • Don't use protected controller methods.
  • Don't use SQL or SQL fragments (where('inviter_id is not null')) outside of models.
  • Keep the db/schema.rb under version control.
  • If there are default values, set them in migrations.
  • Name initializers for their gem name.
  • Order ActiveRecord associations alphabetically by attribute name.
  • Order ActiveRecord validations alphabetically by attribute name.
  • Order controller contents: filters, public methods, private methods.
  • Order model contents: constants, macros, public methods, private methods.
  • Order resourceful routes alphabetically by name.
  • Put application-wide partials in the app/views/application directory.
  • Use _path, not _url, for named routes everywhere except mailer views.
  • Use def self.method, not the scope :method DSL.
  • Use SQL, not ActiveRecord models, in migrations.
  • Use the default render 'partial' syntax over render partial: 'partial'.
  • Use the :only option to explicitly state exposed routes.

Background Jobs

  • Define a PRIORITY constant at the top of delayed job classes.
  • Define two public methods: self.enqueue and perform.
  • Put delayed job classes in app/jobs.

Email

Testing

Sample

  • Avoid its, let, let!, specify, before, and subject.
  • Avoid using instance variables in tests.
  • Don't prefix it block descriptions with 'should'.
  • Name outer describe blocks after the method under test. Use .method for class methods and #method for instance methods.
  • Order ActiveRecord association tests alphabetically by attribute name.
  • Order ActiveRecord validation tests alphabetically by attribute name.
  • Order factories.rb contents: sequences, traits, factory definitions.
  • Order factory attributes: implicit attributes, explicit attributes, child factory definitions. Each section's attributes are alphabetical.
  • Order factory definitions alphabetically by factory name.
  • Prefer eq to == in RSpec.
  • Separate setup, exercise, verification, and teardown phases with newlines.
  • Use an it example for each execution path through the method.
  • Use one factories.rb file per project.
  • Use stubs and spies (not mocks) in isolated tests.
Something went wrong with that request. Please try again.