Руководство по внесению вклада в 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. Прежде чем создавать новую проблему, проверьте, не существует ли уже подобной проблемы.
2. Если проблема связана с ошибкой выполнения программы, укажите используемую версию NoahV и текущую версию системы.
3. Заголовок проблемы должен быть кратким и точно описывать возникшую проблему. Не создавайте бессмысленные заголовки проблем.