Руководство по списку изменений

Заголовок PR следует Conventional Commits для упрощения генерации списка изменений. Формат один из следующих:

<Тип>: <Тема PR>
<Тип>(<Область>, <Область>, ...): <Тема PR>

Например, заголовок PR может быть:

feat: add new mutation
feat(port): port mutation description from DDA

Заголовок PR должен быть понятен игрокам с первого взгляда. Рекомендуется использовать повелительное и описательное название (<глагол> <существительное>), например:

- feat: rebalancing some rifles
+ feat: nerf jam chance of m16 and m4

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

Тип

Тип — это первое слово в заголовке PR. Они указывают тип вносимого изменения. Если сомневаетесь, используйте feat для новых функций и fix для исправлений ошибок. Вот некоторые часто используемые категории:

feat: Функции

Новые функции, дополнения или изменения баланса.

fix: Исправления ошибок

Все, что исправляет ошибку или делает игру более стабильной.

refactor: Инфраструктура

Упрощение разработки без изменения поведения. Например:

  • Рефакторинг и переработка C++
  • Реорганизация Json
  • Изменения в docs/, .github/ и репозитории
  • другие инструменты разработки

build: Сборка

Улучшение процесса сборки:

  • более надежный
  • проще в использовании
  • более быстрое время компиляции

Другое

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

Области

  1. Используйте их в скобках после категории, чтобы еще больше сузить область вашего PR.
  2. Нет ограничений на количество областей.
  3. Они необязательны, но рекомендуются.
  4. это только рекомендации, а не правила. свободно выбирайте лучшее для вашего PR!

<Нет>: Общие функции

Например,

Изменения, связанные с игроком:

  • игрок может делать что-то новое (например: мутации, навыки)
  • с игроком может случиться что-то новое (например: новая болезнь)

Новый контент, такой как:

  • новые монстры
  • новые области карты
  • новые предметы
  • новые транспортные средства
  • новые штуковины

Пример заголовка PR:

feat: strength training activity
feat: mutation system overhaul
feat: semi-plausible smokeless gunpowder recipe
feat(port): game store

lua: Изменения в Lua API

Изменения в Lua API, такие как:

Пример заголовка PR:

feat(lua): add dialogue bindings

UI: Интерфейсы

Изменения UI/UX, такие как:

  • добавление поддержки мыши
  • добавление/настройка меню
  • изменение горячих клавиш
  • оптимизация рабочих процессов
  • улучшения качества жизни (QoL)

Пример заголовка PR:

feat(UI): More info about items dropped with bags
feat(UI): overhaul encumbrance UI

i18n: Интернационализация

Улучшение перевода и поддержки других языков.

fix(UI,i18n): recipe names not translated unless learned

mods или mods/<MOD_ID>: Моды

  • изменения, содержащиеся внутри мода
  • расширяет возможности внутри мода

Пример заголовка PR:

feat(mods/Magical_Nights): add missing owlbear pelts recipe
fix(mods): No Hope doesn't make the world freezing

balance: Изменения баланса

Изменения игрового баланса.

Пример заголовка PR:

feat(balance): Give moose pelts instead of hides

port: Порты из DDA или других форков

Пример заголовка PR:

feat(port): game shop