Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

90 lines (70 loc) · 3.05 KB
Raw

Contributing

Governance

We, the maintainers of Bourbon, would like you to know what to expect when interacting with this project's repo.

As a user of Bourbon, you can expect care to be put into official releases. The maintainers cannot guarantee that the master branch will have the same API forever.

If you review pull requests or comment on issues, you are expected to abide by our code of conduct.

As a contributor, submitting a pull request or opening an issue, you can expect an initial response from a maintainer within two weeks. The maintainers cannot guarantee that we will accept all feature requests, and may fix bugs in ways other than how the contributor suggests. You are expected to abide by our code of conduct.

As a maintainer, you can merge pull requests (even your own) at any time. Maintainers are encouraged to request code review from others at thoughtbot or any relevant peers. You are expected to abide by our code of conduct.

Only members of thoughtbot may be maintainers.

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.

We use stylelint to lint our CSS and Sass. It's configuration can be found in .stylelintrc.json. You can run stylelint from the command line via npm run stylelint, or integrate it with your text editor.

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