Table of Contents

Semver and Releases RU

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Semver and Releases RU

English version: Semver-and-Releases

Это краткая русскоязычная версия страницы про semver и политику релизов. Полная и наиболее актуальная страница: Semver-and-Releases.

Зачем нужна эта страница

Она объясняет, как в проекте понимать:

что считается публичным API;
что считается ломающим изменением;
как выбирать целевую версию;
как changelog и version file должны соотноситься.

Что считается публичным API

Обычно сюда входят:

exported types и methods;
вспомогательные методы вроде AnswerLong(...);
behavior, на который пользователи библиотеки разумно опираются;
документированная семантика времени выполнения.

Что считается ломающим изменением

Ломающее изменение — это не только удаление функции.

Сюда же относятся:

несовместимые изменения сигнатур;
изменение поведения во время выполнения, которое ломает существующий код;
удаление или переименование публичных вспомогательных методов;
изменение документированной семантики без совместимого запасного варианта.

Как выбирать версию

Логика обычная semver:

patch для совместимых исправлений;
minor для совместимых расширений;
major для ломающих изменений.

Release candidates дополнительно обозначают нестабильную стадию развития API.

Связь с changelog

При изменениях в main repository changelog должен отражать user-visible изменения и совпадать с version file.

Wiki-only изменения в .wiki в основной CHANGELOG.md не попадают.

Практический вывод

Не делай ломающих изменений без осознанного решения по версии.
Сначала определяй целевую версию, потом меняй API.
Поддерживай changelog, tags и version file согласованными.

Wiki

Semver and Releases RU

Зачем нужна эта страница

Что считается публичным API

Что считается ломающим изменением

Как выбирать версию

Связь с changelog

Практический вывод

Что читать дальше

Navigation

Start here

Runtime and Architecture

Interaction and Telegram API

Practical Guides

Maintenance