Contributing

Here's how to get started developing features for skeleton-kit. Thanks for helping out!

Installation

Node.JS 10 or higher is required.

Install yarn then type this to install all dependencies:

yarn

Run the test suite as you edit files:

yarn test --watch

Start a storybook server:

yarn storybook

Check for TypeScript errors as you edit files:

yarn tsc -w

Check for eslint errors:

yarn lint

Check for prettier formatting errors:

yarn prettier-check

Storybook is automatically deployed to GitHub Pages any time a change lands on the main branch.

To manually deploy a Storybook build, first create a GitHub token with all repo and workflow scopes. Run this from the main branch to deploy:

GH_TOKEN=[your_token] yarn deploy-storybook

Make sure all PRs have been merged
Edit package.json and increment the version
If there are breaking changes since the last release, make it a major release according to semver guidelines
Create a new release from GitHub with a tag and title like v1.0.0
List all changes for the version
Check out that tag locally and run yarn publish
TODO: automate this