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

OSCHINA-MIRROR/antv-g2plot

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.zh-CN.md 9.3 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 04.03.2025 09:57 43b265d

Правила внесения кода

Если у вас есть вопросы, пожалуйста, создайте issue, или непосредственно отправьте PR!

Создание issue

  • Убедитесь, что вы определили тип issue.
  • Избегайте создания повторяющихся issue; перед тем как создать issue, проверьте существующие.
  • В метках (см. Классификация меток), заголовке или содержании отразите конкретную цель.

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

Внесение кода

Отправка Pull Request

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

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

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

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

При этом сообщении fix(роль): использование роли должно быть xxx следует заменить на более конкретное описание ваших изменений. Например:

$ git commit -m "fix(role): ensure role usage follows the new guidelines"
```После этого вы сможете создать Pull Request на странице [g2plot](https://github.com/antvis/g2plot/pulls).

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

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

### Стиль кода

Ваш стиль кода должен проходить проверку eslint. Вы можете выполнить локальную проверку с помощью команды `$ npm run lint`.

### Нормы коммита

Согласно [нормам Angular](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format) для коммитов,
это делает историю более понятной и позволяет автоматически генерировать changelog.

```xml
<type>(<scope>): <subject>
<ПУСТАЯ СТРОКА>
<body>
<ПУСТАЯ СТРОКА>
<footer>

(1) typeТип коммита, который может включать следующие варианты:

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

(2) Область измененияОбласть изменений в файлах

(3) тема

Опишите одной фразой, что было сделано в этом коммите.

(4) описание

Дополнительно расширяет тему, объясняя причины и цели, если это необходимо.

(5) нижний колонтитул

  • При наличии несовместимых изменений (BREAKING CHANGE) должно быть подробно описано здесь
  • Указание связанных проблем (Issues), например Закрыто #1, Закрыто #2, #3

Пример

fix($compile): [BREAKING_CHANGE] несколько юнит тестов для IE9

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

Изменение зафиксировано в antvis/scale#12

Закрыто #392

BREAKING CHANGE:

  Брейкейт api foo.bar, следует использовать вместо него foo.baz

Смотреть полную документацию

Управление выпусками

Scale использует semver для управления версиями.

master ветка является текущей стабильной версией.

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

Политика выпусков

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

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

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

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

  • Инициирует новый Proposal MR, пишет историю согласно node CHANGELOG, корректирует документацию относительно версий, коммиты могут быть автоматически созданы.

    $ npm run commits
  • Назначает нового менеджера выпуска для следующего основного выпуска.

При выпуске:

  • Сохраняет старую стабильную версию (master) в ветке с названием текущего основного выпуска (например 1.x) и устанавливает тэг {v}.x (v — текущая версия, например 1.x).
  • Выпускает новую стабильную версию на npm и информирует верхние уровни о необходимости обновления.
  • Перед выполнением команды npm publish, рекомендуется прочитать «Как я публикую npm пакет».

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

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

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