slaid098/voice_assistant
Watch
1
0
Fork
You've already forked voice_assistant
 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

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

Merged
slaid098 merged 3 commits from docs/platform-cleanup into master 2026-08-12 18:19:57 +03:00
Conversation 1 Commits 3 Files changed 3 +9 -2
slaid098 commented 2026-08-12 18:14:43 +03:00
Owner
Copy link

Что сделано

  • Удалена строка **Платформы:** Windows из CHANGELOG-секции v0.1.0 (откат PR #29)
  • Добавлен classifier Operating System :: Microsoft :: Windows :: Windows 10 в pyproject.toml
  • Добавлена секция «Требования» / «Requirements» в README (билингва, Windows 10+)

Почему

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

PR #29 добавил **Платформы:** Windows в CHANGELOG v0.1.0 — нарушение нового стандарта. Этот PR откатывает и фиксирует Windows 10+ в pyproject + README.

Watch out

  • После merge нужно PATCH'ем обновить body релиза v0.1.0 на Forgejo (через экстрактор release_notes.py — body будет без **Платформы:**)
  • Min версия Windows 10+ фактически гарантирована Python 3.13 (dropped Windows 7/8), но теперь задокументирована явно

Pending

  • PATCH релиза v0.1.0 на Forgejo (оркестратор после merge)

Closes #30

## Что сделано - Удалена строка `**Платформы:** Windows` из CHANGELOG-секции v0.1.0 (откат PR #29) - Добавлен classifier `Operating System :: Microsoft :: Windows :: Windows 10` в pyproject.toml - Добавлена секция «Требования» / «Requirements» в README (билингва, Windows 10+) ## Почему Issue #63 в opencode-config закрыт — `platform` arg удалён из `create-changelog` tool. Индустриальный стандарт (VSCode/OBS/yt-dlp/espanso): платформа в README + pyproject, не в release notes. Min версия ОС в CHANGELOG — только при поднятии (breaking change в `### Изменено`). PR #29 добавил `**Платформы:** Windows` в CHANGELOG v0.1.0 — нарушение нового стандарта. Этот PR откатывает и фиксирует Windows 10+ в pyproject + README. ## Watch out - После merge нужно PATCH'ем обновить body релиза v0.1.0 на Forgejo (через экстрактор `release_notes.py` — body будет без `**Платформы:**`) - Min версия Windows 10+ фактически гарантирована Python 3.13 (dropped Windows 7/8), но теперь задокументирована явно ## Pending - PATCH релиза v0.1.0 на Forgejo (оркестратор после merge) Closes #30
docs(readme): add Requirements section with Windows 10+
All checks were successful
CI / typecheck (pull_request) Successful in 2m1s
Details
CI / lint (pull_request) Successful in 2m1s
Details
CI / complexity (pull_request) Successful in 2m1s
Details
CI / test (pull_request) Successful in 4m18s
Details
5fcec2930b
slaid098 commented 2026-08-12 18:19:50 +03:00
Author
Owner
Copy link

Code Review Summary

Проверены все 3 изменённых файла (CHANGELOG.md, pyproject.toml, README.md) против критериев приёмки issue #30. CI green, 3 логических коммита, src/ не тронут.

Соответствие критериям issue #30

  • ✅ **Платформы:** Windows удалён из CHANGELOG-секции v0.1.0 (diff: -2 строки, включая пустую после)
  • ✅ Нет двойных пустых строк в CHANGELOG после удаления — ## [0.1.0] — 2026-08-11 → одна пустая → ### Added (строки 30-32)
  • ✅ Operating System :: Microsoft :: Windows :: Windows 10 classifier добавлен в pyproject.toml (строка 21)
  • ✅ TOML валидный (проверено tomllib.load)
  • ✅ Остальные classifiers не тронуты (только +1 строка, alphabetical/logical order сохранён — после общего Operating System :: Microsoft :: Windows)
  • ✅ Секция «Требования» / «Requirements» добавлена в README (билингва: EN строки 73-75, RU строки 136-138)
  • ✅ Указано Windows 10+ в обеих локализациях
  • ✅ README сохраняет 12 delimiter tags (tagline-en/ru, summary-en/ru, features-en/ru — по 2 start/end = 12, grep подтвердил)
  • ✅ Секция размещена правильно: после Quick Start, перед --- и следующим major разделом
  • ✅ ruff/mypy/pytest проходят (CI green по pipeline-status)
  • ✅ 3 логических коммита (changelog, pyproject, readme — отдельно)
  • ✅ Код в src/ не тронут (diff только 3 docs/config файла)

Cross-file impact

PR меняет README (writer) — project-status.py:check_readme (reader) парсит 12 delimiter tags. Tags сохранены полностью (12/12) — reader не сломается. pyproject.toml classifier добавление не ломает project-status.py pyproject checks (новый classifier валиден). Cross-file check пройден.

Positives

  • Чистый откат нарушения из PR #29 + фиксация стандарта в правильных местах (pyproject + README)
  • Билингва согласована: EN и RU формулировки зеркальные, обе ссылаются на Python 3.13 как причину Windows 10+
  • Classifier добавлен в правильной позиции (после общего Operating System :: Microsoft :: Windows, перед Programming Language) — сохранён логический порядок
  • PR body качественный: ## Что сделано / ## Почему / ## Watch out / ## Pending заполнены осмысленно, Closes #30 присутствует
  • Watch out корректно отмечает follow-up: PATCH релиза v0.1.0 на Forgejo после merge

Suggestions (info, не блокирующие)

  • README.md:73 [style] Секция ### Requirements размещена после Quick Start (соответствует ТЗ), но общепринятый UX-паттерн — требования ДО инструкции по запуску (пользователь сначала проверяет совместимость, потом скачивает). Для будущего рефакторинга: рассмотреть перемещение Requirements перед Quick Start в обеих локализациях. Не блокирующее — текущее размещение соответствует issue #30.
  • README.md:75 [style] Формулировка Windows 10+ (Python 3.13 requires Windows 10 or later) корректна, но Windows 10+ уже неявно включает Windows 11. Можно упростить до Windows 10+ (требуется Python 3.13+) — но текущий вариант информативнее для пользователя, не знающего про Python. Оставить как есть.

Verdict: APPROVE

## Code Review Summary Проверены все 3 изменённых файла (CHANGELOG.md, pyproject.toml, README.md) против критериев приёмки issue #30. CI green, 3 логических коммита, src/ не тронут. ### Соответствие критериям issue #30 - ✅ `**Платформы:** Windows` удалён из CHANGELOG-секции v0.1.0 (diff: -2 строки, включая пустую после) - ✅ Нет двойных пустых строк в CHANGELOG после удаления — `## [0.1.0] — 2026-08-11` → одна пустая → `### Added` (строки 30-32) - ✅ `Operating System :: Microsoft :: Windows :: Windows 10` classifier добавлен в pyproject.toml (строка 21) - ✅ TOML валидный (проверено `tomllib.load`) - ✅ Остальные classifiers не тронуты (только +1 строка, alphabetical/logical order сохранён — после общего `Operating System :: Microsoft :: Windows`) - ✅ Секция «Требования» / «Requirements» добавлена в README (билингва: EN строки 73-75, RU строки 136-138) - ✅ Указано `Windows 10+` в обеих локализациях - ✅ README сохраняет 12 delimiter tags (tagline-en/ru, summary-en/ru, features-en/ru — по 2 start/end = 12, grep подтвердил) - ✅ Секция размещена правильно: после Quick Start, перед `---` и следующим major разделом - ✅ ruff/mypy/pytest проходят (CI green по pipeline-status) - ✅ 3 логических коммита (changelog, pyproject, readme — отдельно) - ✅ Код в src/ не тронут (diff только 3 docs/config файла) ### Cross-file impact PR меняет README (writer) — `project-status.py:check_readme` (reader) парсит 12 delimiter tags. Tags сохранены полностью (12/12) — reader не сломается. pyproject.toml classifier добавление не ломает `project-status.py` pyproject checks (новый classifier валиден). Cross-file check пройден. ### Positives - Чистый откат нарушения из PR #29 + фиксация стандарта в правильных местах (pyproject + README) - Билингва согласована: EN и RU формулировки зеркальные, обе ссылаются на Python 3.13 как причину Windows 10+ - Classifier добавлен в правильной позиции (после общего `Operating System :: Microsoft :: Windows`, перед `Programming Language`) — сохранён логический порядок - PR body качественный: `## Что сделано` / `## Почему` / `## Watch out` / `## Pending` заполнены осмысленно, `Closes #30` присутствует - Watch out корректно отмечает follow-up: PATCH релиза v0.1.0 на Forgejo после merge ### Suggestions (info, не блокирующие) - **README.md:73** [style] Секция `### Requirements` размещена после Quick Start (соответствует ТЗ), но общепринятый UX-паттерн — требования ДО инструкции по запуску (пользователь сначала проверяет совместимость, потом скачивает). Для будущего рефакторинга: рассмотреть перемещение Requirements перед Quick Start в обеих локализациях. Не блокирующее — текущее размещение соответствует issue #30. - **README.md:75** [style] Формулировка `Windows 10+ (Python 3.13 requires Windows 10 or later)` корректна, но `Windows 10+` уже неявно включает Windows 11. Можно упростить до `Windows 10+ (требуется Python 3.13+)` — но текущий вариант информативнее для пользователя, не знающего про Python. Оставить как есть. ### Verdict: APPROVE
slaid098 merged commit e0ce9a23cf into master 2026-08-12 18:19:57 +03:00
slaid098 deleted branch docs/platform-cleanup 2026-08-12 18:19:57 +03:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
breaking-change

   
bug

   
ci

   
docs

   
documentation

   
enhancement

   
infrastructure

   
refactor

   
release
No labels
breaking-change
bug
ci
docs
documentation
enhancement
infrastructure
refactor
release
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
slaid098/voice_assistant!31
No description provided.