Skip to content

Development Guide

Guy Sopher edited this page Sep 16, 2019 · 3 revisions

Development Guide

Local Environment

  • Clone the repo: git clone [email protected]:wix-incubator/pro-gallery.git
  • Install lerna: npm i -g lerna
  • Install Dependencies: npm run bootstrap
  • Run the packages: npm run watch

The playground will open in localhost:3000, linked to a local instance of the gallery and layouts.

Committing Changes

Commit messages should be formatted according to the Conventional Commits methodology.

[package] type (optional scope): description
  • package: gallery / playground / layouts
  • type: fix / improve / feature / BREAKING CHANGE

Releasing a Version

Releasing a new version is done via the main library using one of the following commands: npm run patch / npm run minor / npm run major *

* Usually, fixes and improvements are patches, new features are minor versions and breaking changes are major versions.

After running one of these commands, VSCode will open the changelog with the latest commits. After editing it, choose yes in the prompt and the version will be released.