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

Благодарим вас за использование NoahV. NoahV — это фреймворк для разработки фронтенда на основе Vue, который помогает разработчикам повысить эффективность разработки фронтенда через два аспекта: инженерия (с использованием таких инструментов, как каркасы, средства отладки и компиляции) и компонентность (бизнес-компоненты, шаблоны страниц и панели мониторинга). Он в основном подходит для систем управления бэкендом, таких как управление эксплуатацией и обслуживанием, мониторинг и создание отчётов о данных.

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

1. Введение

Прежде чем вносить свой код или предлагать улучшения, пожалуйста, сначала ознакомьтесь с структурой каталога исходного кода NoahV с открытым исходным кодом:

Исходный код NoahV с открытым исходным кодом в основном состоит из пяти больших блоков: библиотека компонентов, функциональный модуль (навигация/конфигурация макета страницы, многоязычность, моделирование данных, запрос данных, статистика выполнения), шаблон проекта, каркас и документация по использованию. Они соответствуют следующим каталогам:

• components (библиотека компонентов):

  • common (включает бизнес-компоненты и шаблоны);
  • visual (визуальные компоненты).

• packages (функциональный модуль):

  • noahv-core (обработка запускающих функций фреймворка);
  • noahv-i18n (многоязычность);
  • noahv-mockup (моделирование данных);
  • noahv-request (запрос данных);
  • noahv-tongji (статистика данных).

• template (шаблон проекта):

  • common (общий шаблон проекта);
  • dashboard (шаблоны проектов с функциями панели мониторинга);
  • common-ts (общая версия шаблона проекта на Typescript).

• tools/noahv-cli (каркас).

• doc (документация по использованию).

2. Стандарт Pull Request

1. Форкните полную версию кода NoahV на свой собственный GitHub.
2. Клонируйте форкнутый код на локальный компьютер и внесите изменения.
3. Заполните информацию о фиксации в соответствии с стандартом заполнения информации о фиксации.
4. Перед отправкой PR выполните перебазирование.
5. Отправьте PR в ветку dev, прямые отправки в ветку master будут отклонены.
6. Пожалуйста, опишите проблему, которую решает отправленный код, как можно более подробно в PR.

3. Стандарт Issue

1. Прежде чем отправлять issue, вы можете сначала поискать, есть ли уже связанные issue.
2. Если это ошибка выполнения программы, предоставьте используемую версию NoahV и текущую информацию о версии системы.
3. Заголовок issue должен быть как можно более кратким описанием проблемы, с которой вы столкнулись, и не создавайте бессмысленные заголовки issue.