CONTRIBUTING.md

Contributing

Feel free to create tickets for bugs or feature requests, or to submit PRs. (More guidance for contributing coming soon)

Developing with ds-sorter

Linting with ESLint, Prettier, and Types

To scan the project for linting errors

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint

npm run lint:prettier

To automatically fix any linting errors

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint

npm run format:prettier

Testing with Web Test Runner

To run the suite of Web Test Runner tests

npm run test

To run the tests in watch mode

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook

npm run storybook

To build a production version of Storybook,

npm run storybook:build

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html