@samewave/sui

This Ember add-on contains the SUI components used in Samewave Client.
Styleguide can be viewed here: https://samewave.github.io/sui-lib/

Installation

• git clone [email protected]:SameWave/sui-lib.git sui-lib
• cd sui-lib
• yarn install

Running

• ember serve
• Visit your app at http://localhost:4200.

Running Tests

• yarn test (Runs ember try:each to test the addon against multiple Ember versions)
• ember test
• ember test --server

Local development integration with consuming projects

To see changes in this add-on appear in consuming projects without publishing a new version do the following:
In this add-on's directory run: yarn link
Then in the consuming project's directory run: yarn link "@samewave/sui"

Releasing a new version

We use ember-cli-release to manage addon version, NPM publishing and Github Pages deployment.

You need to have the following two environment variables set in your .bash_rc or .zshrc file before you can release a new version:

export NPM_TOKEN=xxx
export GITHUB_TOKEN=xxx

• Log into NPM if you are not already logged in.
  npm login
  username: xxx
  password: xxx
  email: [email protected]
  (You will find the NPM login details in 1Password)
• Get the NPM token in the ~/.npmrc file.
• Get a GitHub token from your profile in GitHub
• make release then answer the prompts.

Commit tagging

We follow similar tagging strategy for commits as what Ember expects: https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md#commit-tagging

• [BUGFIX] for any bug related commits
• [FEATURE] for feature related commits
• [DOC] for documentation related commits
• [CHORE] for commits not related to the above, but important enough to show in changelog
• [IGNORE] for commits that you do not want to show up in the changelog file

The commit messages will automatically for part of the generated CHANGELOG.md file.