Skip to content
This repository has been archived by the owner on Jul 14, 2023. It is now read-only.

Latest commit

 

History

History
50 lines (37 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 2.06 KB
Raw

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct. Here’s a quick guide:

  1. Fork the repository.
  2. Make your changes in a topic branch.
  3. Run rake to see if you changes are breaking any existing functionality.
  4. Squash your commits into a single one (more on that here).
  5. Rebase against origin/master, push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

  • Fix a bug, refactor code or expand an existing feature.
  • Write RSpec tests for your new features.
  • Use the right syntax and naming conventions.
  • Update parts of the documentation that are affected by your contribution.

Git Commit Messages

  • Capitalize your commit messages.
  • Start your message with a verb.
  • Use present tense.
  • Refer to the issue/PR number in your squashed commit message.

SCSS Style Guide

  • Two spaces, no tabs.
  • Dashes instead of underscores or camel case: span-columns not span_columns or spanColumns
  • Names should be descriptive and written in full-words: $visual-grid-color not $color or $vslgrd-clr
  • Space between property and value: width: 20px not width:20px
  • Declarations within a block should be ordered alphabetically.
  • Blank lines between rules.
  • No trailing whitespace. Blank lines should not have any space.

Contrib examples

For user-facing changes, please provide an example in sample page contained in the ./contrib folder. Also, please put a screenshot of the changes into the Pull Request.

To see the ./contrib example page:

  1. Install node
  • Run npm install
  • Run npm run contrib