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

OSCHINA-MIRROR/antv-l7plot-antv-l7plot

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(1)type

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

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

(2)scope

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

(3)subject

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

(4)body

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

(5)footer

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

например.

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

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

Документируйте изменение на antvis/l7plot#123

Закрывает #392

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

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

Release

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

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

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

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

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

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

Подготовка

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

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

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

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

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

1
https://api.gitlife.ru/oschina-mirror/antv-l7plot-antv-l7plot.git
git@api.gitlife.ru:oschina-mirror/antv-l7plot-antv-l7plot.git
oschina-mirror
antv-l7plot-antv-l7plot
antv-l7plot-antv-l7plot
main