From c53c0367519bd6b96ce347d63b66ff25701c08f7 Mon Sep 17 00:00:00 2001 From: Andrey Date: Sun, 25 Jan 2026 16:19:56 +0300 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D0=BB=20?= =?UTF-8?q?=D0=BD=D0=BE=D0=B2=D1=83=D1=8E=20=D0=B8=D0=BD=D1=81=D1=82=D1=80?= =?UTF-8?q?=D1=83=D0=BA=D1=86=D0=B8=D1=8E=20=D0=B4=D0=BB=D1=8F=20=D0=BD?= =?UTF-8?q?=D0=B0=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=D0=B8=D1=8F=20=D0=B4=D0=BE?= =?UTF-8?q?=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .cursor/rules/release-notes-template.md | 124 ++++++++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 .cursor/rules/release-notes-template.md diff --git a/.cursor/rules/release-notes-template.md b/.cursor/rules/release-notes-template.md new file mode 100644 index 0000000..ebde57e --- /dev/null +++ b/.cursor/rules/release-notes-template.md @@ -0,0 +1,124 @@ +# Инструкция по оформлению Release Notes + +## Назначение +Этот документ описывает структуру и формат для создания файлов Release Notes (например, `docs/RELEASE_NOTES_DEV-XX.md`). + +## Структура документа + +### 1. Заголовок +```markdown +# Release Notes: [название-ветки] +``` + +### 2. Обзор +Краткий абзац (1-2 предложения), описывающий: +- Количество коммитов в ветке +- Основные направления изменений + +**Формат:** +```markdown +## Обзор +Ветка [название] содержит [N] коммитов с ключевыми улучшениями: [краткое перечисление основных изменений]. +``` + +### 3. Ключевые изменения +Основной раздел с пронумерованными подразделами для каждого значимого изменения. + +**Структура каждого подраздела:** +```markdown +### [Номер]. [Название изменения] + +**Коммит:** `[hash]` + +**Что сделано:** +- [Краткое описание изменения 1] +- [Краткое описание изменения 2] +- [Краткое описание изменения 3] +``` + +**Правила:** +- Каждое изменение = отдельный подраздел +- Название должно быть кратким и понятным +- В разделе "Что сделано" используй маркированные списки +- НЕ перечисляй затронутые файлы +- НЕ указывай статистику строк кода +- Фокусируйся на сути изменений, а не на технических деталях +- Разделяй подразделы горизонтальной линией `---` + +### 4. Основные достижения +Раздел с чекбоксами, подводящий итоги релиза. + +**Формат:** +```markdown +## 🎯 Основные достижения + +✅ [Достижение 1] +✅ [Достижение 2] +✅ [Достижение 3] +``` + +**Правила:** +- Используй эмодзи ✅ для каждого достижения +- Каждое достижение на отдельной строке +- Краткие формулировки (3-5 слов) +- Фокусируйся на ключевых фичах и улучшениях + +### 5. Временная шкала разработки +Раздел с информацией о сроках разработки. + +**Формат:** +```markdown +## 📅 Временная шкала разработки + +**Последние изменения:** [дата] +**Основная разработка:** [период] +**Предыдущие улучшения:** [контекст предыдущих веток/изменений] + +**Хронология коммитов:** +- `[hash]` - [дата и время] - [краткое описание] +- `[hash]` - [дата и время] - [краткое описание] +``` + +**Правила:** +- Используй реальные даты из коммитов +- Формат даты: "DD месяц YYYY" (например, "25 января 2026") +- Для времени используй формат "HH:MM" +- Хронология должна быть в хронологическом порядке (от старых к новым) + +## Стиль написания + +### Общие правила: +- **Краткость**: Фокусируйся на сути, избегай избыточных деталей +- **Ясность**: Используй простые и понятные формулировки +- **Структурированность**: Информация должна быть легко читаемой и сканируемой +- **Без технических деталей**: Не перечисляй файлы, классы, методы (только если это ключевая фича) +- **Без статистики**: Не указывай количество строк кода, файлов и т.д. + +### Язык: +- Используй прошедшее время для описания изменений ("Добавлена", "Реализована", "Обновлена") +- Избегай технического жаргона, если это не необходимо +- Используй активный залог + +### Эмодзи: +- 🔥 для раздела "Ключевые изменения" +- 🎯 для раздела "Основные достижения" +- 📅 для раздела "Временная шкала разработки" +- ✅ для чекбоксов достижений + +## Пример использования + +При создании Release Notes для новой ветки: + +1. Получи список коммитов: `git log [base-branch]..[target-branch] --oneline` +2. Для каждого значимого коммита создай подраздел в "Ключевые изменения" +3. Собери основные достижения в раздел "Основные достижения" +4. Добавь временную шкалу с реальными датами коммитов +5. Проверь, что документ следует структуре и стилю + +## Важные замечания + +- **НЕ включай** информацию о коммитах, которые уже были в базовой ветке (master/main) +- **НЕ перечисляй** все файлы, которые были изменены +- **НЕ указывай** статистику строк кода +- **Фокусируйся** на функциональных изменениях, а не на технических деталях реализации +- Используй **реальные даты** из коммитов, а не предполагаемые