docs: document release notes files

This commit is contained in:
Vitovt 2026-05-19 22:22:49 +03:00
parent 1b7b50caff
commit 8a1622025e

10
release-notes/README.md Normal file
View file

@ -0,0 +1,10 @@
# Release Notes
Create one Markdown file per release tag, named exactly after the version:
```text
release-notes/1.2.0.md
release-notes/1.2.1.md
```
When a version tag is pushed, the release workflow uses the matching file as the GitHub release description. The file must be committed before the tag is pushed.