docs(platform): remove platform mark from CHANGELOG, document Windows 10+ in pyproject + README #30

New issue

Closed

opened 2026-08-12 18:13:36 +03:00 by slaid098 · 0 comments

slaid098 commented

2026-08-12 18:13:36 +03:00

Owner

Контекст

Issue #63 в opencode-config закрыт: platform arg удалён из create-changelog tool. Индустриальный стандарт (исследование VSCode/OBS/yt-dlp/espanso): платформа указывается в pyproject.toml classifiers + README, а не в release notes. Min версия ОС в CHANGELOG — только при поднятии (как breaking change в ### Изменено).

PR #29 в voice_assistant добавил **Платформы:** Windows в CHANGELOG-секцию v0.1.0 — это нарушение нового стандарта. Нужно откатить.

Минимальная версия Windows 10+ сейчас нигде не задокументирована явно (только косвенно через requires-python>=3.13, т.к. Python 3.13 dropped Windows 7/8). Нужно зафиксировать в pyproject.toml classifier и README.

Задача

Удалить строку **Платформы:** Windows из CHANGELOG-секции ## [0.1.0] — 2026-08-11 (и пустую строку после неё, чтобы не было двойных пробелов)
Добавить Operating System :: Microsoft :: Windows :: Windows 10 classifier в pyproject.toml (в существующий список classifiers, после Operating System :: Microsoft :: Windows)
Добавить секцию «Требования» в README.md (билингва EN/RU) с указанием Windows 10+ (как minimum supported OS)
PATCH релиза v0.1.0 на Forgejo через экстрактор — body без **Платформы:** (выполняется после merge PR, оркестратором)

Контракты

Что меняется

CHANGELOG.md — секция v0.1.0: удалить **Платформы:** Windows + пустую строку
pyproject.toml — classifiers: добавить Operating System :: Microsoft :: Windows :: Windows 10
README.md — добавить секцию «Требования» / «Requirements» (билингва)

Что НЕ меняется

CHANGELOG секция [Unreleased] — не трогать
Содержимое bullets v0.1.0 — не трогать (только удалить строку платформы)
Остальные classifiers в pyproject.toml — не трогать
Структура README (delimiter tags, features, quick start) — не трогать
Код в src/ — не трогать
release_notes.py экстрактор — не трогать (он пассивный, передаст что есть)

Формат секции «Требования» в README

README билингва EN/RU с delimiter tags (см. существующую структуру). Секцию добавить ПОСЛЕ Quick Start, ДО Features.

EN вариант (внутри  delimiter):

## Requirements

**OS:** Windows 10+ (Python 3.13 requires Windows 10 or later)

RU вариант (после delimiter):

## 🇷🇺 Требования

**ОС:** Windows 10+ (Python 3.13 требует Windows 10 или новее)

Инварианты

CHANGELOG остаётся валидным (Keep a Changelog 1.1.0 формат)
pyproject.toml остаётся валидным TOML
README сохраняет 12 delimiter tags (для slaid098.dev showcase)
ruff/mypy/pytest проходят (код не трогаем, но проверь)
Экстрактор release_notes.py корректно извлекает секцию v0.1.0 без платформы

Граничные случаи

Удаление пустой строки после **Платформы:** Windows — важно чтобы не осталось двойного перевода строки между ## [0.1.0] и ### Added
Classifier Windows :: Windows 10 — это валидный PyPI classifier (https://peps.python.org/pep-0301/#operating-system-microsoft-windows-windows-10)
Если в README уже есть секция с требованиями — не дублировать, а добавить строку туда

Влияние на связанные компоненты

CHANGELOG.md — основной файл изменений
pyproject.toml — добавление classifier
README.md — добавление секции «Требования»
scripts/release_notes.py — НЕ трогать (пассивный)
.github/workflows/release.yml — НЕ трогать
Релиз v0.1.0 на Forgejo — PATCH body после merge (отдельная операция)

Вне scope

Пересоздание релиза (delete+create) — не делаем, только PATCH body
Очистка CHANGELOG в video_uniq — отдельный issue
Изменение create-changelog tool — уже сделано в opencode-config issue #63
Добавление Windows 11 classifier — не нужно (поддержка 10+, не только 11)

Критерии приемки

**Платформы:** Windows удалён из CHANGELOG-секции v0.1.0
Нет двойных пустых строк в CHANGELOG после удаления
Operating System :: Microsoft :: Windows :: Windows 10 classifier добавлен в pyproject.toml
Секция «Требования» / «Requirements» добавлена в README (билингва)
README сохраняет 12 delimiter tags
ruff/mypy/pytest проходят

## Контекст Issue #63 в opencode-config закрыт: `platform` arg удалён из `create-changelog` tool. Индустриальный стандарт (исследование VSCode/OBS/yt-dlp/espanso): платформа указывается в pyproject.toml classifiers + README, а не в release notes. Min версия ОС в CHANGELOG — только при поднятии (как breaking change в `### Изменено`). PR #29 в voice_assistant добавил `**Платформы:** Windows` в CHANGELOG-секцию v0.1.0 — это нарушение нового стандарта. Нужно откатить. Минимальная версия Windows 10+ сейчас нигде не задокументирована явно (только косвенно через requires-python>=3.13, т.к. Python 3.13 dropped Windows 7/8). Нужно зафиксировать в pyproject.toml classifier и README. ## Задача 1. Удалить строку `**Платформы:** Windows` из CHANGELOG-секции `## [0.1.0] — 2026-08-11` (и пустую строку после неё, чтобы не было двойных пробелов) 2. Добавить `Operating System :: Microsoft :: Windows :: Windows 10` classifier в `pyproject.toml` (в существующий список classifiers, после `Operating System :: Microsoft :: Windows`) 3. Добавить секцию «Требования» в README.md (билингва EN/RU) с указанием `Windows 10+` (как minimum supported OS) 4. PATCH релиза v0.1.0 на Forgejo через экстрактор — body без `**Платформы:**` (выполняется после merge PR, оркестратором) ## Контракты ### Что меняется - `CHANGELOG.md` — секция v0.1.0: удалить `**Платформы:** Windows` + пустую строку - `pyproject.toml` — classifiers: добавить `Operating System :: Microsoft :: Windows :: Windows 10` - `README.md` — добавить секцию «Требования» / «Requirements» (билингва) ### Что НЕ меняется - CHANGELOG секция [Unreleased] — не трогать - Содержимое bullets v0.1.0 — не трогать (только удалить строку платформы) - Остальные classifiers в pyproject.toml — не трогать - Структура README (delimiter tags, features, quick start) — не трогать - Код в src/ — не трогать - `release_notes.py` экстрактор — не трогать (он пассивный, передаст что есть) ### Формат секции «Требования» в README README билингва EN/RU с delimiter tags (см. существующую структуру). Секцию добавить ПОСЛЕ Quick Start, ДО Features. EN вариант (внутри `` delimiter): ``` ## Requirements **OS:** Windows 10+ (Python 3.13 requires Windows 10 or later) ``` RU вариант (после delimiter): ``` ## 🇷🇺 Требования **ОС:** Windows 10+ (Python 3.13 требует Windows 10 или новее) ``` ## Инварианты - CHANGELOG остаётся валидным (Keep a Changelog 1.1.0 формат) - pyproject.toml остаётся валидным TOML - README сохраняет 12 delimiter tags (для slaid098.dev showcase) - ruff/mypy/pytest проходят (код не трогаем, но проверь) - Экстрактор `release_notes.py` корректно извлекает секцию v0.1.0 без платформы ## Граничные случаи - Удаление пустой строки после `**Платформы:** Windows` — важно чтобы не осталось двойного перевода строки между `## [0.1.0]` и `### Added` - Classifier `Windows :: Windows 10` — это валидный PyPI classifier (https://peps.python.org/pep-0301/#operating-system-microsoft-windows-windows-10) - Если в README уже есть секция с требованиями — не дублировать, а добавить строку туда ## Влияние на связанные компоненты - `CHANGELOG.md` — основной файл изменений - `pyproject.toml` — добавление classifier - `README.md` — добавление секции «Требования» - `scripts/release_notes.py` — НЕ трогать (пассивный) - `.github/workflows/release.yml` — НЕ трогать - Релиз v0.1.0 на Forgejo — PATCH body после merge (отдельная операция) ## Вне scope - Пересоздание релиза (delete+create) — не делаем, только PATCH body - Очистка CHANGELOG в video_uniq — отдельный issue - Изменение `create-changelog` tool — уже сделано в opencode-config issue #63 - Добавление `Windows 11` classifier — не нужно (поддержка 10+, не только 11) ## Критерии приемки - [ ] `**Платформы:** Windows` удалён из CHANGELOG-секции v0.1.0 - [ ] Нет двойных пустых строк в CHANGELOG после удаления - [ ] `Operating System :: Microsoft :: Windows :: Windows 10` classifier добавлен в pyproject.toml - [ ] Секция «Требования» / «Requirements» добавлена в README (билингва) - [ ] README сохраняет 12 delimiter tags - [ ] ruff/mypy/pytest проходят

slaid098 added the

docs

label

2026-08-12 18:13:36 +03:00

slaid098 referenced this issue from a pull request that will close it,

2026-08-12 18:14:43 +03:00

docs(platform): remove platform mark from CHANGELOG, document Windows 10+ #31

slaid098 referenced this issue

2026-08-12 18:19:50 +03:00

docs(platform): remove platform mark from CHANGELOG, document Windows 10+ #31

slaid098 closed this issue

2026-08-12 18:19:57 +03:00