Skip to content

Update README.md #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
czertyaka merged 2 commits into from
Sep 13, 2025
Merged

Update README.md #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f2a8c2
Update README.md
czertyaka Sep 13, 2025
e71524a
Update README.md
czertyaka Sep 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,19 @@ make help
```sh
PREFIX=<INSTALL_PATH> make install
```

## Версионирование проекта

В проекте адаптированы правила
[семантического версионирования](https://semver.org/).
Однако, напрямую они использоваться не могут: семантическое версионирование предполагает наличие API
у проекта.

Правила, по которым адаптирован semver:
1. Если был удален документ, необходимо увеличить `MAJOR` версию.
2. Если был добавлен новый документ, или была добавлена новая информация в существующий документ, необходимо
увеличить `MINOR` версию.
3. Если были внесены исправления в существующий документ, или были структурные изменения без внесения
новой информации, необходимо увеличить `PATCH` версию.

Данные правила действуют с версии 1.0.0.