Русский | English

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

Нормы внесения кода

1. Клонирование исходного кода

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

2. Установка зависимостей

2.1. Установка pnpm

Для использования pnpm workspace сначала установите pnpm.

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 CODING STYLES

5. Внесение изменений

5.1. Нормы коммита

Согласно стандарту Angular используйте типы коммитов, чтобы история была более понятной.

Типы коммитов включают следующее:

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

Попробуйте использовать одно предложение для описания ваших изменений, подробнее см. документацию.

5.2. Создание набора изменений

Мы используем changesets для автоматической версионной публикации. После завершения работы выполните changeset и отправьте его.

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

5.3. Отправка Pull Request

Если у вас есть права доступа к репозиторию и вы хотите внести свой вклад, создайте ветку, сделайте необходимые изменения и отправьте Pull Request. Разработчики AntV проверят ваш запрос и объединят его с основной веткой.

# Сначала создайте ветку для разработки, название должно быть осмысленным, избегайте таких слов как update, tmp и т.п.
$ git checkout -b branch-name

# Сохраните изменения, сообщение о которых указано ниже

$ git add . # git add -u удаленные файлы
$ git commit -m "fix: role.use должен быть xxx"
$ git push origin branch-name

После этого вы можете создать Pull Request на странице L7.

Чтобы было легче проследить историю, убедитесь, что при отправке MR вы указали следующую информацию:

1. Точка требований (обычно связана с issue или комментариями)
2. Причина обновления (не связанная с issue, краткое описание того, почему это требуется)
3. Тестовые точки фреймворка (может быть связано с тестовым файлом, нет необходимости подробного описания, достаточно ключевых моментов)
4. Основные моменты (относительно пользователя, может отсутствовать, обычно это неполное совместимое обновление, которое требует дополнительного уведомления)

6. Версионирование

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

Подробный процесс версионирования

1. Перейдите к GitHub Action и активируйте действие Create bump version PR, выберите ветку выпуска и активируйте действие.

2. Подождите до завершения действия, после чего будет создан Pull Request для обновления версий.

3. Проверьте содержимое Pull Request, если все в порядке, одобрите его, затем запустите действие для выпуска версии, которое также опубликует версию на NPM, добавит тэг на GitHub и создаст релиз на GitHub.

4. Если шаг 3 выполнен успешно, будет отправлено уведомление через DingTalk, автоматически объединится Pull Request и автоматически развернется новый сайт.

5. Если шаг 3 не выполнен успешно, будет отправлено уведомление через DingTalk, проверьте причину отказа на странице GitHub Actions.

6.2. Ручное версионирование

1. Создайте локальную ветку release.
2. Если нет новых изменений для выпуска, выполните скрипт pnpm run changeset, чтобы создать набор изменений для текущего выпуска, затем выполните коммит.
3. Выполните скрипт pnpm run version-packages, чтобы обновить номер версии и Changelog для пакетов, затем выполните коммит.
4. Выполните скрипт pnpm run publish-packages, чтобы опубликовать пакеты на NPM и добавить тэги на GitHub.
5. Объедините изменения ветки release в основную ветку через Pull Request.
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 с основной веткой через Pull Request.
3. Выпустите версию, используя тот же процесс автоматического выпуска версии онлайн, либо выберите ручное управление версией.