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

OSCHINA-MIRROR/mirrors-AntV-F2

Клонировать/Скачать
CONTRIBUTING.md 10 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 29.06.2025 08:04 2a01c24

Руководство по вкладу

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

Декларация новых проблем

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

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

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

Руководство по созданию PR

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

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

# Инициализируйте проект
$ npm i
$ npm run bootstrap

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

Если ваши изменения прошли тесты, поздравляем! Пришло время вернуть вашу работу нам. Обратите внимание, что сообщение о коммите должно быть записано в следующем формате.

$ git add . # git add -u для удаления файлов $ git commit -m "fix(роль): метод role.use должен xxx" $ git push origin branch-name


Затем вы можете создать Pull Request на [f2](https://github.com/antvis/f2/pulls).

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

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

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

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

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

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

```xml
<type>(<scope>): <subject>
<Пустая строка>
<body>
<Пустая строка>
<footer>

(1) type

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

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

(2) scope

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

(3) subject

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

(4) body

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

(5) footer

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

Пример:

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

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

Документация изменений на antvis/f2#123

Закрыто #392

BREAKING CHANGE:

  Разрывы API foo.bar, следует использовать foo.baz вместо

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

Выпуск

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

Стратегия ветвей

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

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

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

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

Подготовка

  • Установите милицейскую веху. Подтвердите, что запрос связан с этой вехой.

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

  • Подтвердите, что тест производительности пройден и все проблемы в текущей версии либо закрыты, либо могут быть отложены до последующих версий.
  • Откройте новый [MR предложения выпуска], и запишите Историю как node CHANGELOG. Не забудьте исправить содержание документации, связанное с выпускаемой версией. Коммиты могут быть сгенерированы автоматически.
    $ npm run commits
  • Назначьте PM для следующей стабильной версии.

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

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

1
https://api.gitlife.ru/oschina-mirror/mirrors-AntV-F2.git
git@api.gitlife.ru:oschina-mirror/mirrors-AntV-F2.git
oschina-mirror
mirrors-AntV-F2
mirrors-AntV-F2
master