CONTRIBUTING.md

Contributing to skymp-ui-components

Before you started development

• Learn rules of Code of Conduct
• Learn style guide: https://github.com/airbnb/javascript https://www.robinwieruch.de/javascript-naming-conventions

How to start developed?

1. Clone this repository

git clone https://github.com/svyatoslavratov/skymp-ui-components.git

2. Install all dependencies

npm install

3. Run the complete test suite

npm run test

4. Start development

npm run start

Where are components tested and view?

Begin testing and view components with Storybook

npm run storybook

Storybook will available on localhost on port that point in package.json

Development workflow

• npm start runs rollup watcher
• npm run lint checks the code style
• npm test runs the complete test suite
• npm pretty runs prettier with autofix
• npm run storybook builds and runs the storybook on localhost

More scripts see in package.json

Recommended extensions for VS code

These extensions will create best developer experience

• ESLint | look at github

• Prettier - Code formatter | look at github

• stylelint | look at github

• EditorConfig for VS Code | look at github

• GitLens — Git supercharged | look at github

• Auto Close Tag | look at github

• Auto Rename Tag | look at github

• Markdown Preview Enhanced | look at github