SmartBiz Style Guide

Base style guide for SmartBiz projects. An npm package that can be installed into any repo.

Installation

• To add the styles in this package to your project, type the following in your root directory

  npm install @smartbizloans/styleguide

Publishing

Before you can edit and update this package you must do the following:

• sign up for an npm account [https://www.npmjs.com/]
• If you were not automatically added to the smartbizloans organization, contact Thomas so he can add you

Setup local

• git clone the styleguide from sbabiz organization on github
• cd into your local clone

Workflow

• Login with your npm credentials after typing the following command

  npm login

• Cut a branch off of develop
• Make your edits
• Commit and push your changes.
• When the directory is clean, update the version number appropriately
  • This module follows semantic versioning [https://semver.org/]
  • Type the command below, choosing either major, minor, or patch
  • %s = version number

  npm version [major | minor | patch] %s -m "version x.x.x"

• make a pull request to merge your changes to master
• review changes
• merge to master

Update Package

• If you already have the package installed and want to see your changes or add updates, type

  npm update @smartbizloans/styleguide

That's it!