Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

54 lines (42 loc) · 1.59 KB
Raw

Contributing to Lost Pixel

Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.

Developing

The development branch is canary. This is the branch that all pull requests should be made against. The changes on the canary branch are published to the @canary tag on npm regularly.

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.

    git clone https://github.com/lost-pixel/lost-pixel.git

  2. Create a new branch:

    git checkout -b MY_BRANCH_NAME

  3. Install the dependencies with:

    npm install

  4. Build storybook to execute lost-pixel against

    npm run build-example-storybook

  5. Start developing and execute the action against the local static build of storybook:

    npm run dev

Running tests

Lost Pixel is committed to testing the core flows of the application, so if you are contributing to those we highly encourage you to add test coverage as well.

To run test locally:

npm run test

Linting application

To check the formatting of your code:

npm run lint

Getting your work merged

When you are satisfied with your work open a PR against the canary branch and somebody from project maintainers will help you review & merge it!