Browncoat 1.0.0

Tracey

About

Browncoat is a front-end prototype tool. Documentation is served from the /docs directory. Application is served from the /web directory. Both use browsersync's built-in static server.

Install

Make sure Node 4.x or higher is installed. (Optionally you can use yarn instead of npm).

# Install dependencies
npm install
yarn install

# Opens browser to localhost:3000 to view docs
npm run docs
yarn run docs

# Opens browser to localhost:3000 to view app (empty by default)
npm run gulp
yarn run gulp

# Run Tests
npm test
yarn test

Versioning

Browncoat uses semver specifications.

<major>.<minor>.<patch>

Version change checklist:

• MUST update _main.json version
• MUST update package.json version
• MUST update README.md version
• Major updates MUST change codename
• Major updates MUST create a new tag
• Minor updates MAY change codename
• Minor updates MAY create a new tag
• Patch updates MUST NOT change codename
• Patch updates on major version MUST create a new tag
• Update important changes
• Update changelog.md

Commits

Commits MUST be in this format:

# type: "version", "task", "chore", or "patch"
# optional: short name (do not capitalize)
# description: A short description (do not capitalize)
# additional: Any additional information MUST be added after 2 returns (do capitalize)
$ type(optional): description
>
> Additional
# eg.
$ task: add scss section to docs
$ chore: clean up tests
$ version(0.5.1): prepare release
$ patch: fix failing Tavis CI tests

Visual Regression Testing with Wraith [BROKEN / HOLD]

[Testing with wraith on hold to look at alternatives and decide whether we should continue using wraith.]

Visual regression testing added as of version 0.4. Uses wraith, a screenshot comparison tool created by BBC news. Requires Wraith be installed. Instructions at their github page.

To set a baseline for your project run:

wraith history config

This creates a baseline of shots based on config file settings.

After making changes run:

wraith latest config

This will create a comparison between the history and latest changes.

Important Changes from v1.0.0-beta

• Removed old css and added autoprefixer
• Added yarn.lock
• Minor bug fixes