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

OSCHINA-MIRROR/antv-X6

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

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

Если у вас есть какие-либо комментарии или советы, пожалуйста, сообщите о своей проблеме issue или внесите любые изменения по своему усмотрению и отправьте PR.

Сообщение о новых проблемах

  • Пожалуйста, укажите, что это за проблема.
  • Прежде чем сообщать о проблеме, поищите связанные проблемы. Убедитесь, что вы не собираетесь открывать дублирующую проблему.
  • Четко объясните свою цель в метках, заголовке или содержании.

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

Отправка кода

Руководство по запросу на вытягивание (Pull Request)

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

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

# Запустите тест после завершения модификации. Добавьте новые тестовые случаи или измените старые, если считаете это необходимым
$ npm test

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

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

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

  1. Need: Какую функцию вы хотите достичь (как правило, укажите, какая проблема связана).
  2. Updating Reason: Отличается от проблемы. Кратко опишите свою причину и логику того, почему вам нужно сделать такую модификацию.
  3. Related Testing: Кратко опишите, какая часть тестирования относится к вашей модификации.
  4. User Tips: Обратите внимание для пользователей x6. Вы можете пропустить эту часть, если PR не связан с обновлением API или потенциальной проблемой совместимости.

Стиль руководства

eslint может помочь выявить проблемы стиля, которые могут существовать в вашем коде. Ваш код должен пройти тест от eslint. Запустите тест локально с помощью $ npm run lint.

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

Рекомендуется использовать angular commit-message-format, чтобы написать сообщение коммита. Таким образом, мы сможем получить более отслеживаемую историю и автоматически сгенерированный журнал изменений.

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

(1)type

Должен быть одним из следующих:

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

(2)scope

Область действия может быть любой, указывающей место изменения коммита.

(3)subject

Используйте лаконичные слова, чтобы описать, что вы сделали в изменении коммита.

(4)body

Не стесняйтесь добавлять больше контента в тело, если вы считаете, что предмет недостаточно понятен, например, какова его цель или причины вашего коммита.

(5)footer

  • Если коммит является критическим изменением, пожалуйста, четко отметьте это в этой части.
  • связанные проблемы, такие как Closes #1, Closes #2, #3

например.

fix($compile): [BREAKING_CHANGE] пара модульных тестов для IE9

Старые IE сериализуют HTML в верхнем регистре, но IE9 этого не делает...
Было бы лучше ожидать нечувствительности к регистру, к сожалению, jasmine не позволяет использовать регулярные выражения для ожиданий броска.

Изменение документа на antvis/x6#123

Закрывает #392 **BREAKING CHANGE:**

Нарушает работу API foo.bar, вместо него следует использовать foo.baz.

Подробнее смотрите в этих файлах.

Выпуск

В процессе выпуска X6 использует семантическое управление версиями на основе semver.

Стратегия ветвления

master-ветка — это последняя стабильная версия.

  • Просто создайте develop-ветку из master.
  • Все новые функции будут добавлены в master или next, а также все исправления ошибок, кроме проблем безопасности. Таким образом, мы можем мотивировать разработчиков обновиться до последней стабильной версии.

Стратегия выпуска

При выпуске каждой стабильной версии будет назначен менеджер проекта (PM), который будет выполнять следующие обязанности на разных этапах выпуска.

Подготовка

  • Установите веху. Подтвердите, что запрос связан с вехой.

Перед выпуском

  • Подтвердите, что тест производительности пройден и все проблемы текущей вехи либо закрыты, либо могут быть отложены до более поздних версий.
  • Откройте новое предложение по выпуску MR и напишите History как CHANGELOG узла. Не забудьте исправить содержание документации, связанной с версией выпуска.
  • Назначьте PM для следующей стабильной версии.

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

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

1
https://api.gitlife.ru/oschina-mirror/antv-X6.git
git@api.gitlife.ru:oschina-mirror/antv-X6.git
oschina-mirror
antv-X6
antv-X6
master