Permalink
Fetching contributors…
Cannot retrieve contributors at this time
65 lines (51 sloc) 1.93 KB

Contributing

By participating in this project, you agree to abide by the thoughtbot code of conduct.

Pull Requests

We welcome pull requests from everyone. Here’s a quick guide:

  1. Fork the repository and clone to your machine.
  2. Run bundle install.
  3. Make sure the tests pass: bundle exec rake.
  4. Make your change, following our style guide (below). Write tests. Make sure the tests pass: bundle exec rake.
  5. Write a good commit message. Push to your fork and submit a pull request. If Hound catches style violations, fix them.
  6. Wait for us. We try to at least comment on pull requests within one week. We may suggest changes.

Style Guide

Bourbon uses Sass’s SCSS syntax and aligns to thoughtbot’s style guides. High-level notes:

  • Use two-space indentation (no tabs).
  • Use double quotation marks.
  • Use hyphens when naming things: hide-visually rather than hide_visually or hideVisually.
  • Use one space between property and value: width: 20px rather than width:20px.
  • Names should be descriptive and aim for clarity over brevity: $all-text-inputs-hover rather than $inputshover or $alltxthvr.
  • Order CSS declarations alphabetically.
  • No trailing whitespace.

Documentation

We use SassDoc to document Bourbon. Annotations should be ordered:

  • @link
  • @see
  • @type
  • @argument
  • @content
  • @property
  • @return
  • @example
  • @require
  • @access
  • @since
  • @author
  • @deprecated
  • @todo