summaryrefslogtreecommitdiffstats
path: root/DOCS/release-policy.md
diff options
context:
space:
mode:
authorsfan5 <sfan5@live.de>2023-07-17 11:52:31 +0200
committersfan5 <sfan5@live.de>2023-07-17 11:55:45 +0200
commit8a6cabce3583affb63940795cf30b0be51a7722d (patch)
tree85de5d7615dea8e6fdbb1cbbd86c2bfda9dcee5b /DOCS/release-policy.md
parent9e6c6c08975c03b771adc1d2b524d91a985ed2b9 (diff)
downloadmpv-8a6cabce3583affb63940795cf30b0be51a7722d.tar.bz2
mpv-8a6cabce3583affb63940795cf30b0be51a7722d.tar.xz
DOCS/release-policy.md: add additional advice
Diffstat (limited to 'DOCS/release-policy.md')
-rw-r--r--DOCS/release-policy.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/DOCS/release-policy.md b/DOCS/release-policy.md
index af55d0f5e7..2426ab4e7c 100644
--- a/DOCS/release-policy.md
+++ b/DOCS/release-policy.md
@@ -44,6 +44,9 @@ If necessary (to e.g. exclude commits already on master), the release can
be done on a branch with different commit history. The release branch **must**
then be merged to master so `git describe` will pick up the tag.
+This does not apply to patch releases, which are tagged directly on the
+`release/0.X` branch. The master branch always remains at v0.X.0.
+
Release notes template
----------------------
@@ -67,13 +70,13 @@ New
Changed
~~~~~~~
-- List of removed features
+- List of changed features
Removed
-~~~~~~~~~~
+~~~~~~~
-- List of deprecated features
+- List of removed features
Options and Commands
@@ -117,10 +120,19 @@ A complete changelog can be seen by running `git log <start>..<end>`
in the git repository.
```
-Note that the "Release 0.X.Y" title should be removed when creating a new GitHub
-release.
-
When creating a new point release its changes should be added on top of the
`RELEASE_NOTES` file (with the appropriate title) so that all the changes in
the current 0.X branch will be included. This way the `RELEASE_NOTES` file
can be used by distributors as changelog for point releases too.
+
+The changelog of lists all changes since the last release, including those
+that have been backported to patch releases already.
+
+Some additional advice:
+- Especially for features, try to reword the messages so that the user-visible
+ change is clear to the reader. But don't simplify too much or be too verbose.
+- It often makes sense to merge multiple related changes into one line
+- Changes that have been made and reverted within the same release must not
+ appear in the changelog
+- Limit the "Options and Commands" section to relevant changes
+- When filling in the GitHub release, remove the "Release 0.X.Y" heading