Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 1.91 KB
Raw

Contributing

We are open to and grateful for any contributions made by the community.

Overview

Local Development

After cloning the repository first install the dependencies:

# Yarn
yarn install

# NPM
npm install

After the installation has completed you can run the local development environment:

# Yarn
yarn dev

# NPM
npm run dev

If you want to test your changes in another project, use npm link or yarn link.

Storybook

If you prefer to work within Storybook, we have that set up aswell.

To launch the Storybook development environment run:

# Yarn
yarn storybook

# NPM
npm run storybook

We are working on integrating Storybook with the chayns environment, however many APIs are not available there yet. Some components that rely on the chayns-js API might not work within Storybook.

Pull Requests

If you found a bug or miss a feature, you are welcome to create a pull request and add the desired features yourself. Follow these steps:

  1. Fork this repository
  2. Do your changes and commit them
  3. Create a pull request from your fork to the master branch of this repository

Please avoid including unrelated commits to your pull request.

Publishing a New Version

The following is only relevant for core contributors (members of the TobitSoftware GitHub organization).

To publish a new version of the chayns-components-package simply push a new Git-tag to the repository.

npm version will create a tag automatically, so use this command to increase the version and push the created tag to publish a new version to npm.