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

OSCHINA-MIRROR/antv-g2plot-antv-g2plot

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

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

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

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

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

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

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

Руководство по запросу на включение изменений

Если вы разработчик репозитория 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

Затем вы можете создать запрос на включение изменений в g2plot.

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

  1. Нужно: Какую функцию вы хотите достичь (как правило, укажите, какая проблема связана).
  2. Причина обновления: Отличается от проблемы. Кратко опишите свою причину и логику того, почему вам нужно сделать такую модификацию.
  3. Связанное тестирование: Кратко опишите, какая часть тестирования относится к вашей модификации.
  4. Советы пользователям: Обратите внимание на пользователей g2plot. Вы можете пропустить эту часть, если 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: Изменения в процессе сборки или вспомогательных инструментах и библиотеках, таких как генерация документации
  • deps: Обновления зависимостей

(2)scope

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

(3)subject

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

(4)body

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

(5)footer

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

например.

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

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

Document change on antvis/g2plot#123

Closes #392

BREAKING CHANGE:

  Breaks foo.bar api, foo.baz следует использовать вместо этого

Посмотрите эти файлы для получения более подробной информации.

Release

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

Branch Strategy

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

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

Release Strategy

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

Preparation

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

Before Release

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

  • Откройте новое [Release Proposal MR] и напишите History как [node CHANGELOG]. Не забудьте исправить содержимое документации, относящееся к выпускаемой версии. Коммиты могут быть созданы автоматически.

    $ npm run commits
  • Назначьте PM для следующей стабильной версии.

[semver] {: http://semver.org/lang/zh-CN/ [release proposal mr]: https://github.com/nodejs/node/pull/4181 [node changelog]: https://github.com/nodejs/node/blob/master/CHANGELOG.md [『我是如何发布一个 npm 包的』]: https://fengmk2.com/blog/2016/how-i-publish-a-npm-package

Примечание: часть текста не удалось перевести из-за отсутствия контекста.

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

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

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