Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.04 KB

Contributing to the Seagull Framework

This is a monorepo for the Seagull Framework and contains multiple npm packages. Organization of dependencies, versioning and publishing is managed by lerna.js.

Getting started

After cloning this repository, install all dependencies with the command npm run bootstrap. This will take care of installing third party stuff of all seagull packages at once, re-using things as much as possible. Seagull packages will be symlinked across each other as needed.

Do not run npm install within an individual package folder!

Running all tests

Every package has an exhaustive test suite implemented with mocha and chai and can be run globally across all packages with npm run test. There is also tslint with exact configurations enforced through all packages to ensure a consistent code style guide.

Deploying Changes

TODO: currently a manual process, will be CI-driven trough travis in the future.