Руководство по внесению вклада

Прежде всего, благодарим вас за внимание к Layui-Vue и ваш вклад! Мы приветствуем все улучшения и предложения. Чтобы ваш вклад был успешно объединён, пожалуйста, следуйте этому руководству.

Структура каталога

Чтобы лучше понять структуру проекта, обратитесь к следующему описанию каталога:

• docs: официальные документы;
• packages: каталог исходного кода компонентов;
  • component: исходный код компонентов Layui-vue;
  • json-schema-form: исходный код компонента json-schema-form;
  • icons: исходный код иконок;
  • layer: исходный код Layer-vue для всплывающих окон;
  • layui: каталог публикации Layui-vue;
• play: каталог для локальной отладки компонентов.

Шаги по отправке PR

1. Форк репозитория: на Gitee форкните этот репозиторий Layui-vue в свой репозиторий.

2. Клонируйте репозиторий: клонируйте форкнутый репозиторий на локальный компьютер.

   git clone https://gitee.com/your-username/layui-vue.git
   cd layui-vue

3. Создайте ветку: создайте новую ветку на основе ветки 2.x для вашей разработки. Рекомендуется использовать имя ветки в формате username/область изменений, например, Jevin/feat-button.

   git checkout -b your-feature-branch

4. Установите зависимости: убедитесь, что вы установили необходимые зависимости.

   pnpm install

5. Локальная разработка: проводите локальную отладку и разработку компонентов в каталоге play.

6. Отправьте изменения: отправьте свои изменения, следуя стандарту Conventional Commits. PR, не соответствующие стандарту отправки, не будут объединены.

   git add .
   git commit -m "feat(button): добавление компонента кнопки"

7. Отправьте ветку: отправьте свою локальную ветку на удалённый репозиторий.

   git push origin your-feature-branch

8. Создайте Pull Request: создайте новый Pull Request на Gitee Layui-vue, описав содержание и цель ваших изменений.

Стандарт отправки

Для поддержания чистоты и согласованности кодовой базы, придерживайтесь следующих стандартов отправки:

• feat: новая функция;
• fix: исправление ошибки;
• docs: только изменение документации;
• style: только настройка стиля компонентов;
• refactor: рефакторинг (не добавление новой функции и не изменение кода для исправления ошибок);
• perf: оптимизация производительности;
• test: добавление тестов;
• chore: изменения в процессе сборки или вспомогательных инструментах.

Заключение

Ещё раз благодарим вас за ваш вклад! Если у вас есть какие-либо вопросы или нужна помощь во время процесса внесения вклада, создайте issue на Gitee, и мы ответим как можно скорее.

Happy coding!

Команда Layui-Vue