Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 3.32 KB
Raw

Contributing to Responsive Foundation

Make sure that you've reviewed the BU Coding Standards before making any changes in this repository.

Development & Release Workflow

All development should occur in the develop branch, or in specialized topic branches which are merged in to develop as they are completed.

When a feature or bug fix is ready for release, changes should be merged from develop in to the master branch and given a unique release tag. Release tags should follow semantic versioning.

Given a version number MAJOR.MINOR.PATCH, increment the:

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards-compatible manner, and
  3. PATCH version when you make backwards-compatible bug fixes.

Before a release is tagged, the change log should be updated to highlight changes since the previous release, and all version references in source files should be bumped to reflect the new version. (Just run grunt version).

Sass

Sass files are separated into two layers.

Base

Base components live in the css-dev/burf directory:

Global mixins utilized by these base components are located in css-dev/burf/_mixins.scss.

Variables defined in this framework should always be defined using the !default flag so that they can be easily overridden.

Theme

The theme layer is importable by way of css-dev/burf-theme.scss, which imports components from the css-dev/burf-theme directory.

Style Guide

A visual style guide for this repository is hosted at https://bu-ist.github.io/responsive-foundation/. This site is powered by Github Pages, which is simply a static HTML site committed to the gh-pages branch of this repository. This is intended to be a living style guide, so be sure that any significant changes to the code in this repository gets a cooresponding update in the style guide.

Source files for the visual style guide live in the _docs directory. Currently this consists of static HTML files as well as a Sass file (_docs/css-dev/docs.scss) that @import's the Foundation files and adds styles specific to the guide. Also included is Prism.js for syntax highlighting.

Several Grunt tasks have been set up to facilitate maintaining the style guide.

  1. Running grunt build will stage the docs site in a .gitignore'd docs directory, copying HTML files from _docs and compiling Sass and Javascript assets.
  2. Running grunt serve will spin up a local development server (using BrowserSync) and watch for changes while you edit source files, re-building as needed.
  3. Running grunt deploy will push the docs directory to the gh-pages branch and update the hosted guide.