Simplified Chinese | Русский

🎉 Добро пожаловать в проект L7! 🎉

Руководство по вкладу

1. Исходный код

git clone https://github.com/antvis/L7 --depth=1

2. Предварительная установка

2.1 Установка pnpm

Поскольку используется pnpm workspace, сначала нужно установить pnpm

OnClickListener 2.2 Установка зависимостей

pnpm install

3. Запуск проекта

# Запустить демонстрацию
pnpm dev

Другие команды:

• pnpm site:dev Запуск локального сайта
• pnpm test:unit Запуск юнит тестов
• pnpm test-cover Запуск юнит тестов и просмотр покрытия кода
• pnpm test:integration Запуск интеграционных тестов
• pnpm build сборка исходного кода пакетов, вывод в umd, es и lib директорию

4. Стиль кода

GUIDELINES FOR CODE

5. Подача кода

5.1 Формат сообщений коммита

Вы можете использовать формат сообщений коммита angular для записи сообщений коммита. Таким образом, мы сможем отслеживать историю более точно и автоматически создавать изменения.

Тип коммита должен быть одним из следующих:

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

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

5.2 Подача набора изменений кода

Мы используем changesets для полностью автоматизированной версионной выпуска. Он может автоматически создавать GitHub Releases и автоматически связывать выпуск с соответствующей задачей. Когда мы завершим разработку, выполним changeset и отправим его.

pnpm run changeset
git add .
git commit -m "chore: commit changeset"

5.3 Руководство по созданию запроса на слияние

Если вы разработчик репозитория AntV и готовы сделать свой вклад, смело создайте новую ветку, завершите свои изменения и отправьте запрос на слияние. Группа AntV проверит вашу работу и сложит её в основную ветку.

# Создайте новую ветку для разработки. Имя ветки должно быть семантическим, избегайте слов типа 'обновление' или 'временная'. Мы рекомендуем использовать feature/xxx, если изменения связаны с реализацией нового функционала.
$ git checkout -b branch-name

# Верните ваши изменения обратно к нам. Обратите внимание, что сообщение коммита должно быть записано в следующем формате.
$ git add . # git add -u для удаления файлов
$ git commit -m "fix: role.use must xxx"
$ git push origin branch-name

Затем вы можете создать запрос на слияние на L7.

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

1. Нужно: Какую функцию вы хотите реализовать (Обычно, укажите, какое задание связано).
2. Причина обновления: В отличие от заданий. Кратко опишите свою причину и логику о том, почему вам нужно сделать такие изменения.
3. Относительные тесты: Кратко опишите какие части тестирования относятся к вашим изменениям.
4. Советы пользователям: Уведомление для крупных пользователей. Вы можете пропустить этот раздел, если запрос на слияние не связан с обновлением API или потенциальной совместимостью.

6. Выпуск

6.1 Автоматический онлайн выпуск версий

1. Перейдите к GitHub Action чтобы запустить действие Create bump version PR, выберите ветку выпуска и запустите действие.
2. Подождите до завершения действия. После завершения действия, будет создан запрос на слияние изменённой версии.
3. Подтвердите изменения версии в запросе на слияние. Если нет проблем, одобрите запрос на слияние и подождите до выполнения действия выпуска версии. В это время он будет опубликован на NPM, помечен на GitHub и будет создан GitHub Release.
4. Если шаг 3 успешен, DingTalk будет уведомлен, робот автоматически сложит запрос на слияние и новый официальный сайт будет автоматически развёрнут в фоновом режиме.
5. Если шаг 3 неудачен, DingTalk сообщит об этом. Перейдите к GitHub Action для проверки причины неудачи.

6.2 Ручной выпуск версий

1. Создайте локальную ветку release
2. Если нет набора изменений для публикации, выполните скрипт pnpm run changeset, чтобы создать набор изменений для этого выпуска версий, и выполните коммит изменений.
3. Выполните скрипт pnpm run version-packages, чтобы обновить номер версии и Changelog для публикуемых пакетов, подтвердите содержимое и выполните коммит.
4. Выполните скрипт pnpm run publish-packages, который опубликует пакет на NPM и пометит его на GitHub.
5. Сложите изменения в ветке release в ветку выпуска, отправив запрос на слияние.
6. Перейдите к GitHub Releases для создания выпуска для этого выпуска. После завершения создания, новый официальный сайт будет автоматически развёрнут.

6.3 Процесс предварительного выпуска версий beta/alpha/next

Пример предварительного выпуска beta: добавляем новую функцию для выпуска beta версии:1. Создайте локальную ветку beta. 2. Выполните команду pnpm exec changeset pre enter beta команду🔗 для входа в режим предварительного выпуска beta. 3. Завершите разработку функции, добавьте набор изменений и отправьте на удалённую ветку beta. 4. Процесс выпуска версий согласован с процессом автоматического онлайн выпуска версий. Также можно выбрать ручной выпуск версий.

После завершения проверки beta версии она объединяется в основной процесс выпуска версий:

1. Выполните команду pnpm exec changeset pre exit команду🔗 для выхода из режима предварительного выпуска.
2. Сложите изменения в ветке beta в основную ветку, отправив запрос на слияние.
3. Процесс выпуска версий согласован с процессом автоматического онлайн выпуска версий. Также можно выбрать ручной выпуск версий.