debian-forge-composer/docs/news/README.md
Lars Karlitski 72f83f9694 docs/news: introduce release notes directory
This directory is meant for longer-form release notes. Add a README.md
that explains it.
2021-01-15 13:21:12 +01:00

12 lines
556 B
Markdown

# Release Notes
This directory contains release notes for _osbuild-composer_ in the form of
short markdown documents, sorted into subdirectories by release.
When proposing a user-visible change, please add a release note into the
`unreleased` directory. The note should explain the change from the perspective
of somebody using _osbuild-composer_ and ideally how the change affects them or
how they can make use of new functionality.
When preparing a release, a maintainer will rename the `unreleased` directory
and summarize its contents in `NEWS.md`.