particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs/news: introduce release notes directory

Browse source 
This directory is meant for longer-form release notes. Add a README.md
that explains it.
This commit is contained in:
Lars Karlitski 2021-01-08 20:09:49 +01:00 • committed by Tom Gundersen
parent 7a5790d6b7
commit 72f83f9694
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/news/README.md Normal file
View file

@ -0,0 +1,12 @@
# 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`.