1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/layui-layui

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 12 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 29.11.2024 10:38 e86af3c

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

Чтобы повысить эффективность коммуникации, пожалуйста, уделите несколько минут внимательному прочтению этого документа. Следование этим указаниям поможет выразить ваше уважение к участникам и разработчикам этого открытого проекта. В свою очередь они также будут относиться с уважением к обработке или оценке ваших запросов и запросов на включение изменений (Pull Request).

Запросы (Issue)

Перед созданием запроса

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

Перед официальным созданием запроса вы должны убедиться, что выполнили следующие предварительные шаги:

  • Тщательно изучите официальный документ Layui и обновления каждой версии: https://layui.dev
  • Ищите похожие проблемы в разделе Issues и найдите решение, но избегайте оставлять комментарии в старых запросах.
  • Используйте другие технические сообщества для поиска соответствующей информации или полностью используйте современные модели искусственного интеллекта.

Почему существуют строгие требования к запросам?

Поддержка открытого проекта — это сложная работа, которая одновременно благородна и немного скромна. Кроме того, порог использования Layui относительно низок, и с ростом популярности мы ежедневно сталкиваемся с различными техническими отзывами, включая запросы о багах, запросы функций и запросы на включение изменений.

Как бесплатный открытый проект, ресурсы поддержки Layui ограничены. Это означает, что для обеспечения устойчивого развития проекта мы должны:

  1. Предоставлять более конкретные задачи и более высокий приоритет (например, исправление ошибок и разработка новых функций).
  2. Повысить эффективность обработки запросов.

Что касается пункта 1, мы решили строго ограничить запросы GitHub конкретными целями и содержанием работы. Вопросы и обсуждения следует отправлять в более подходящие места. Например, если речь идёт об «использовании», рекомендуется отправить его в раздел обсуждений Layui или уточнить его до более конкретных запросов о багах или функциях. Разница между ними заключается в том, что «использование» — это вопрос без предварительного обдумывания и исследования, а запросы о багах и функциях требуют от задающего вопроса дальнейшего уточнения, является ли это дефектом или неподдерживаемой особенностью.

Относительно пункта 2, мы обнаружили, что два фактора оказывают наибольшее влияние на эффективность обработки запросов: a) пользователи создают запросы без предварительной подготовки, что приводит к большому количеству повторяющихся и базовых запросов; b) пользователи создают запросы, не предоставляя достаточно полезной информации, что заставляет нас тратить много времени на общение с пользователями только для получения базовой информации, чтобы мы могли провести настоящий анализ запроса. Поэтому, чтобы уменьшить ненужное потребление ресурсов, строгое требование к запросам является необходимым. Особенно для основных участников Layui, они должны направить свои основные усилия на более важные задачи проекта.

Самое главное, поймите одну вещь: отношения между пользователями и участниками открытого проекта не являются отношениями между заказчиком и исполнителем, и запросы не являются службой поддержки. При создании запроса, пожалуйста, придерживайтесь менталитета «давайте сотрудничать, чтобы решить эту проблему» и избегайте ожидания, что сообщество будет обслуживать вас в одностороннем порядке.

Вышеупомянутое основано на зрелом опыте Ant Design и было адаптировано для сообщества Layui.

После создания запроса

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

После создания запроса

  • Если проблема уже решена в процессе общения по запросу, пожалуйста, закройте запрос самостоятельно.
  • Давайте будем уважать друг друга, понимать и поддерживать хорошее сообщество Layui вместе, спасибо 💖.

Другие справочные материалы

  1. Правила поведения участников
  2. Мудрость задавать вопросы @tvvocold
  3. Зачем нужны минимальные воспроизводимые примеры @antfu

Запросы на включение изменений (Pull Request)

Layui использует гибкую стратегию управления ветками, и мы призываем вас напрямую создавать запросы на включение изменений в соответствующих ветках. Чтобы сделать процессы Review и Merge более плавными, пожалуйста, внимательно прочитайте следующие инструкции:

Описание веток

  • main используется в качестве основной ветки, представляющей текущую стабильную версию проекта, и принимает запросы функций и исправлений.
  • *.x используется в качестве ветки стабильной исторической версии, например, 2.x представляет серию стабильных версий 2.x и принимает только исправления, но не функции.
  • *-dev используется в качестве ветки разработки будущей крупной версии, такой как 3.0-dev, представляющая разработку версии 3.0, и принимает функции и исправления, но не гарантирует стабильность.

Правила фиксации

Layui следует Conventional Commits, и ваши git commit и PR title должны соответствовать этому стандарту.

Шаги операции

  1. Перед созданием PR, пожалуйста, извлеките последний код проекта после извлечения соответствующей ветки и разработайте на основе этой ветки.
  2. В корневом каталоге проекта выполните npm install для установки зависимостей.
  3. После завершения разработки выполните npm run checks, чтобы убедиться, что ваш код прошёл тесты инструментов, таких как test и lint. (2.x ветки не поддерживаются)
  4. При создании PR пожалуйста, следуйте правилам фиксации в заголовке и строго следуйте предоставленному шаблону содержания в описании, чтобы предоставить необходимую информацию, такую как конкретное описание изменений этого PR, онлайн-демонстрационный адрес и т. д.
  5. После отправки PR убедитесь, что он прошёл проверку Github CI, и если нет, вы можете просмотреть конкретную причину и внести коррективы.
  6. После выполнения всех вышеуказанных шагов вы можете ожидать, пока участники проекта проведут Review вашего кода и оценят слияние.

Другие справочные материалы

Опубликовать ( 0 )

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

1
https://api.gitlife.ru/oschina-mirror/layui-layui.git
git@api.gitlife.ru:oschina-mirror/layui-layui.git
oschina-mirror
layui-layui
layui-layui
main