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

OSCHINA-MIRROR/didiopensource-LogicFlow

Клонировать/Скачать
CONTRUBUTING.en-US.md 10 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 30.11.2024 05:46 a67e37d

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

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

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

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

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

Вклад кода

Запросы на вытягивание

Если вы хотите внести улучшения или новые функции, мы будем рады рассмотреть ваш PR :)

$ pnpm install

$ cd packages/core # или другие пакеты, такие как packages/extensions
$ pnpm run build:watch

# создайте новую оболочку
$ cd examples/feature-examples
$ pnpm start

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

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

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

Затем вы можете создать запрос на вытягивание на LogicFlow ✿✿ヽ(°▽°)ノ✿

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

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

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

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

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

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

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

(1)тип

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

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

(2)область действия

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

(3)тема

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

(4)тело

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

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

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

например.

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

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

Изменения в документе @logicflow/core#12.

Закрывает #392.

**Критическое изменение:**

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

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

Выпуск

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

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

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

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

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

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

Подготовка

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

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

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

Выпуск

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

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

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

1
https://api.gitlife.ru/oschina-mirror/didiopensource-LogicFlow.git
git@api.gitlife.ru:oschina-mirror/didiopensource-LogicFlow.git
oschina-mirror
didiopensource-LogicFlow
didiopensource-LogicFlow
master