Участие в проекте vite-plugin-svelte

vite-plugin-svelte объединяет две потрясающие технологии фронтенд-разработки для предоставления отличных возможностей.

• Svelte — это новый способ создания веб-приложений. Это компилятор, который преобразует ваши декларативные компоненты в эффективный JavaScript, который точно обновляет DOM.
• Vite — это новое поколение инструментов сборки для фронтенд-разработки, которое значительно улучшает опыт разработки.

Сайт Open Source Guides предлагает коллекцию ресурсов для индивидуумов, сообществ и компаний. Эти ресурсы помогают людям, желающим узнать, как запустить и участвовать в открытом исходном коде проектах. Вкладчики и люди, новые для открытого исходного кода, найдут следующие руководства особенно полезными:

• Как участвовать в открытом исходном коде
• Построение привлекательных сообществ

Участие

Есть много способов внести свой вклад в Svelte, и многие из них не требуют написания кода. Вот несколько идей, чтобы начать:- Просто начните использовать vite-plugin-svelte. Все работает так, как вы ожидали? Если нет, мы всегда рады улучшениям. Дайте нам знать, открыв новый вопрос.

• Посмотрите открытые вопросы. Предложите решения, запросите уточнения или предложите метки. Помогите сортировать вопросы.
• Если вы нашли проблему, которую хотите исправить, откройте выпуск.
• Прочитайте нашу документацию. Если что-то кажется запутанным или может быть улучшено, откройте выпуск.
• Посмотрите на запрошенные функции другими членами сообщества и рассмотрите возможность открытия выпуска, если вы видите что-то, с чем хотели бы поработать.Вклады очень приветствуются. Если вам кажется, что вам нужна помощь в планировании вашего вклада, пожалуйста, свяжитесь с нами на Discord по адресу svelte.dev/chat и сообщите, что вы ищете немного помощи.

Сортировка вопросов и выпусков

Один из замечательных способов внести свой вклад в проект без написания кода — помочь сортировать вопросы и выпуски, когда они поступают. - Запросите дополнительную информацию, если вы считаете, что проблема не предоставляет всех необходимых деталей для её решения.

• Предложите тэги, которые могут помочь категоризировать проблемы.
• Отметьте старые или ненужные проблемы.
• Запросите планы тестирования и проведите проверку кода.

Проблемы

Мы используем GitHub issues для наших публичных багов. Если вы хотите сообщить о проблеме, взгляните вокруг и посмотрите, нет ли уже открытой проблемы на эту тему. Если вы уверены, что это новый несообщённый баг, вы можете отправить отчёт о баге.

Если у вас есть вопросы по использованию Svelte, свяжитесь с нами в Discord по адресу svelte.dev/chat, и мы сделаем всё возможное, чтобы ответить на ваши вопросы.

Если вы видите что-то, что хотели бы реализовать, создайте запрос на новую функцию.## Отправка новых проблем

Когда вы открываете новую проблему, всегда убедитесь, что заполнили шаблон проблемы. Этот шаг очень важен! Недополнение его может привести к тому, что ваша проблема не будет своевременно рассмотрена. Не воспринимайте это лично, если это произошло, и смело открывайте новую проблему после сбора всей информации, требуемой шаблоном.

• Одна проблема — один баг: Пожалуйста, отчитывайтесь о каждом баге отдельно.
• Укажите шаги воспроизведения: Укажите все шаги, необходимые для воспроизведения проблемы. Человек, читающий ваш отчёт о баге, должен был бы иметь возможность следовать этим шагам для воспроизведения вашей проблемы с минимальными усилиями.

Установка

1. Этот монорепозиторий использует pnpm. Установите его с помощью команды npm i -g pnpm.
2. После клонирования репозитория выполните команду pnpm install, чтобы установить зависимости.
3. Выполните команду pnpm dev, чтобы запустить сборку vite-plugin-svelte в режиме наблюдения.
4. Выполните команду pnpm dev в директории packages/playground/xxx, чтобы запустить vite.

Внесение изменений через pull requests

Ваш первый pull request

Вы решили внести свой вклад обратно в основной проект, открыв pull request. Вы вложили значительное количество времени, и мы ценим это. Мы сделаем всё возможное, чтобы работать вместе с вами и получить ваш pull request на рассмотрение.Работаете над своим первым pull request? Вы можете узнать, как это сделать, из этого бесплатного видеокурса: Как внести свой вклад в открытый проект на GitHub

Предложение изменения

Если вы хотите запросить новую функцию или улучшение, но пока не планируете открывать pull request, вы можете создать issue с использованием шаблона для новых функций.

Если вы исправляете ошибку, то можно сразу отправить pull request, однако мы всё равно рекомендуем создать issue с подробным описанием того, что вы исправили. Это полезно, если мы не примем конкретное исправление, но хотим отслеживать проблему.

Отправка pull request

Маленькие pull request легче проверять и имеют больше шансов быть принятыми. Убедитесь, что ваш pull request выполняет только одну задачу; в противном случае его следует разделить.

При отправке pull request убедитесь, что выполнены следующие шаги:

1. Создайте форк репозитория и создайте свою ветку от main.
2. Опишите ваш план тестирования в описании pull request. Убедитесь, что вы протестировали свои изменения.
3. Убедитесь, что ваш код проходит линтер (pnpm lint).
4. Убедитесь, что ваши тесты проходят (pnpm test).

Все pull request должны быть созданы относительно ветки main.#### Тестирование

Интеграционные тесты для новых функций или регрессионные тесты как часть исправления ошибки очень приветствуются. Добавьте их в проекты в папке packages/e2e-tests.

Документация

Если вы изменили API, обновите документацию.

Журнал изменений

Чтобы изменения были отражены в журнале изменений пакета, запустите pnpm changeset и следуйте указаниям. Вы всегда должны выбрать пакеты, которые вы изменили, вероятнее всего это будет @sveltejs/vite-plugin-svelte.

Что происходит дальше?

Команда Svelte будет отслеживать pull request. Пожалуйста, помогите нам сделать ваш pull request легким для проверки, следуя вышеописанным правилам.

Стиль кода

Eslint найдет большинство стилистических проблем, которые могут существовать в вашем коде. Вы можете проверить стиль вашего кода, просто запустив команду pnpm lint.

Лицензия

Принимая участие в vite-plugin-svelte, вы соглашаетесь с тем, что ваши вклады будут лицензированы под лицензией MIT.