24 lines
1.4 KiB
Plaintext
24 lines
1.4 KiB
Plaintext
---
|
|
description: Поддерживать VERSION и docs/CHANGELOG при изменениях проекта
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Версионирование и документация
|
|
|
|
При **значимых** изменениях кода или поведения:
|
|
|
|
1. Обновить [`VERSION`](../VERSION) (SemVer):
|
|
- **PATCH** — исправления, мелкие правки без смены API/поведения
|
|
- **MINOR** — новая функциональность, обратно совместимая
|
|
- **MAJOR** — ломающие изменения (формат ссылок, схема БД, API)
|
|
|
|
2. Добавить запись в [`docs/CHANGELOG.md`](../docs/CHANGELOG.md) под новой версией (Added / Changed / Fixed / Removed).
|
|
|
|
3. При изменении архитектуры, пайплайна, режимов ZILANT/VOLK или карты файлов — обновить [`docs/ARCHITECTURE.md`](../docs/ARCHITECTURE.md) и при необходимости [`README.md`](../README.md), [`docs/volk-mode.md`](../docs/volk-mode.md).
|
|
|
|
4. Перенос скриптов в `tools/` — обновить [`tools/README.md`](../tools/README.md).
|
|
|
|
5. Не поднимать версию за косметические правки без изменения поведения.
|
|
|
|
Текущая базовая версия: **1.1.0**.
|