Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 1.91 KB
Raw

Contributing to Playable

Commit Message Guidelines

We use conventionalcommits to format our commit messages. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Playable release notes.

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>[optional scope]: <description>

[optional body]

[optional footer]

More info about message format and list of types could be found here

Scope

The scope should be the name of affected playable part (readable for the person reading the changelog generated from commit messages).

The following is the list of supported scopes:

  • core
  • adapters
  • constants
  • modules/NAME_OF_MODULE_HERE
  • modules/ui/NAME_OF_MODULE_HERE

Run playground

Check LIVE video stream

Open https://video-player-media-server-dot-wixgamma.appspot.com

  • Flow:
  • click START
  • use button 'LIVE' on localhost to check player video
  • click END when want to stop stream

Release New Version

To release new version:

  • checkout latest master version: git checkout master & git pull
  • run version script: npm version [major | minor | patch]
  • push master branch and tags: git push origin master & git push origin [NEW_VERSION_TAG]
  • draft a new release on github with changelog from npm version command
  • after CI released new package, publish release on github
  • publish new documentation version npm run documentation:site:deploy