FILE / ScuroNeko/Laniakea

SEMVER.md

Исходный файл и его история в репозитории.
FILE bf323f92ff7dbedc73220553c6775828ebeacc23
Files
Laniakea/SEMVER.md
T
ScuroNeko d78526242b
Golang lint / lint (push) Failing after 1m37s
(new): support Bot API 10.3
(fix): finalize v2 contracts
(tests): cover v2 migration
(doc): prepare release guidance
2026-09-08 23:21:38 +03:00

1.5 KiB

Semantic Versioning Policy

This project follows Semantic Versioning with the rules below.

Public API Surface

The public API consists of:

  • exported identifiers in package laniakea
  • exported identifiers in package tgapi
  • documented behavior in README.md, README_RU.md, and package godoc

Anything unexported is internal and may change without notice.

Breaking Changes

A release requires a major version bump when it changes any of the following:

  • exported function, method, type, field, constant, or variable names
  • function or method signatures
  • JSON field names or request/response wire compatibility in tgapi
  • documented behavioral guarantees relied on by callers

Examples:

  • removing an exported alias
  • changing callback payload encoding defaults
  • changing handler dispatch semantics in a way that breaks existing bots

Minor Changes

A release uses a minor version bump for backward-compatible additions:

  • new exported types, methods, helpers, or update handlers
  • support for new Telegram Bot API fields or methods
  • optional configuration knobs that do not change existing defaults

Patch Changes

A release uses a patch version bump for backward-compatible fixes:

  • bug fixes
  • test-only changes
  • godoc and README clarifications
  • internal refactors with no public behavior change

Pre-Releases

-rc.N builds may still correct release-blocking API defects before the corresponding stable release. After a stable release, breaking changes require a new major version.