Внесение вклада в Dashibase

Спасибо за ваш интерес к Dashibase! Перед тем как начать работу, убедитесь, что вы ознакомились с кодексом поведения и существующими проблемами.

Предварительная информация

Dashibase был создан с использованием следующих фреймворков и инструментов:

• Vue 3
• Vite
• TypeScript
• Tailwind CSS
• Headless UI
• Oh, Vue Icons!
• Vitest
• Playwright

Мы настоятельно рекомендуем участникам быть знакомыми с этими инструментами.

Начальная настройка

Установка зависимостей

Перед тем как приступить к работе над Dashibase, вам потребуется установить и настроить следующие зависимости на вашем компьютере:

• Git
• Node.js v16.x (LTS)
• npm или yarn

Создание форка Dashibase на GitHub

Чтобы внести изменения в код Dashibase, вам нужно создать форк репозитория.

Настройка Dashibase на вашем компьютере

Клонирование репозитория

Для сборки Dashibase вам нужно клонировать свой форк репозитория:

1. Клонируйте ваш форк репозитория GitHub:

   git clone https://github.com/<github_username>/lotion.git

2. Перейдите в директорию Lotion:

   cd lotion

Установка зависимостейУстановите зависимости npm:

```sh
npm i
```

Запуск локального сервера

1. Запустите локальный сервер

   npm run dev

2. Чтобы получить доступ к локальному серверу, введите следующий URL в ваш браузер:

   http://localhost:5173/

Проведение тестов

1. Запуск тестов

Сначала ознакомьтесь с библиотеками, используемыми для тестирования.

Lotion использует Vitest для юнит-тестов и тестов компонентов, а также Playwright для end-to-end тестов.

После клонирования репозитория в вашей локальной среде и выполнения команды npm i, вы можете запустить тесты следующими командами:

npm run test:unit
npm run test:e2e

Те же самые тесты будут выполняться для всех запросов на слияние в ветку main, и все тесты должны пройти успешно перед тем, как будет выполнен запрос на слияние.

2. Напишите тесты

Все новые функции должны сопровождаться хотя бы одним тестом для новой функции.

Все исправления ошибок должны сопровождаться тестом, который воспроизводит эту ошибку.

При написании теста проверьте, что он правильно проваливается до того, как проверять его прохождение.

Подайте свой вклад!

После того как вы сделаете улучшения, вы можете открыть запрос на слияние, и член команды Dashibase (либо SK, либо Alfred пока!) будет работать вместе с вами над этим запросом!У вас возникли проблемы, такие как конфликты слияния, или вы не знаете, как открыть запрос на слияние? Обратитесь к туториалу GitHub по запросам на слияние, чтобы узнать, как решать конфликты слияния и другие проблемы.

Как только ваш запрос на слияние будет объединён, вы будете гордо указаны как вкладчики в нашей диаграмме вкладчиков!