Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.2 KB

DEVELOPMENT.md

File metadata and controls

57 lines (39 loc) · 2.2 KB

Development instructions

Branches

The project is developed in master branch. New feature or fix should come with a pull request from a fork. You can make a pull request from either your master branch or from a feature branch.

Developing the next major version goes in a separate branch made from master.

Running development server and watches

Your gulp needs to be at least v.3.9.0

Install all npm dependencies

npm install

The stylesheet of the style guide itself could be used as test data. Start watching UI code changes in lib/app and build the app using the style guides stylesheets:

gulp dev

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 from master 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_LATEST.md file. You can remove not needed items or rename them.
  8. Prepend the contents of the edited CHANGELOG_LATEST.md to CHANGELOG.md.
  9. Commit changes
  10. Make a pull request from your release branch into master of SC5 organization
  11. Once your pull request is merged, rebase master on your computer against SC5: 1) git fetch upstream 2) git rebase upstream/master
  12. Run npm publish
  13. Create a versioning tag in GitHub. Insert the CHANGELOG_LATEST.md content as a description of this versioning tag.