mperrotti / sassquatch2-lite

A "lite" version of the Meetup Sassquatch framework

Home Page:http://meetup.github.io/sassquatch2/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Sassquatch 2

Sassquatch is a CSS foundation and framework for Meetup, built with Sass.


Documentation

Hologram documentation is built to github pages

An overview of basic Sassquatch2 conventions is also available in the wiki


Installation

Manage installation via bower:

"dependencies": {
  "sassquatch2": "git@github.com:meetup/sassquatch2.git#master",
  ...
  }

Development

Clone this repo and run ./setup.sh.

Code guidelines and standards are documented on the wiki

We use the Gitflow branching model for development:

  • develop - default branch for active development (all PRs diff against develop)
  • release branches - cut from develop, get merged into master
  • master - only release branches and hotfixes get committed to master
  • master branch in theory should always contain the latest stable release

Grunt tasks

Command Result
grunt By default, grunt recompiles Sass and rebuilds Hologram docs
grunt sass Recompiles Sass
grunt hologram Rebuilds Hologram docs
grunt clean Cleans compiled docs and CSS in docs/build
grunt ghpages Caution: commits compiled docs for your branch to gh-pages

Creating a release

Until I write the script for creating a release, the process is unfortunately manual. Because we're using the git-flow branching model, all fix and feature commits flow into the develop branch. The master branch is our "production" branch.

To create a release:

  1. merge changes from develop into master
  2. increment the version number in bower.json
  3. commit the result & push
  4. git tag -a vX.X.X -m "tag message"
  5. git push origin vX.X.X

Once the tag ref is pushed to origin the version is available to install in chapstick or elsewhere.

About

A "lite" version of the Meetup Sassquatch framework

http://meetup.github.io/sassquatch2/

License:MIT License


Languages

Language:CSS 98.1%Language:JavaScript 1.0%Language:Shell 0.7%Language:Ruby 0.1%