Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.8 KB

DEVELOPMENT.md

File metadata and controls

47 lines (32 loc) · 1.8 KB
Raw

Development instructions

Running development server and watches

The project contains a small demo stylesheet that can be used to develop the UI. Start watching UI code changes in lib/app and build the app using the demo stylesheets:

gulp dev

Running the task also runs a small development server, and does the same as:

gulp watch --source ./lib/app --output ./demo-output --config ./lib/app/styleguide_config.json

Running tests

Run all the tests and JSCS linting with

npm test

Node module tests are ran with Mocha, UI related tests with Karma & PhantomJS.

Coding convention

This project follows AirBNB-ish JavaScript coding convention (with a few changes). It is tuned to use JSCS as a code checker. The checking is injected into the testing process, so you can see in Travis respond to your pull-request if your files follow the convention.

To be able to check during development, please

How to release

  1. Check that all the needed pull requests are merged
  2. Make sure that your clone fetched all the tags which exist in the SC5 repo
  3. Rebase your master branch against SC5
  4. Create release/x.y.z branch with the number of upcoming version and switch to it
  5. Increment the package number in package.json
  6. Run gulp publish
  7. Check the CHANGELOG.md file. You can remove not needed items or rename them.
  8. Commit changes
  9. Make a pull request from your feature branch
  10. Once your pull request is merged, rebase your master against SC5 again
  11. Run npm publish
  12. Create a versioning tag in GitHub. Insert the CHANGELOG.md content as a description of this versioning tag.