From 1088232f2c2d6029516ed1229cd23c8a30951645 Mon Sep 17 00:00:00 2001 From: Slyghtning Date: Thu, 27 Jul 2023 15:13:55 +0200 Subject: [PATCH] docs: update release notes --- release_notes.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/release_notes.md b/release_notes.md index 53d184139..03d1aa8d3 100644 --- a/release_notes.md +++ b/release_notes.md @@ -1,8 +1,16 @@ # Loop Client Release Notes +This file tracks release notes for the loop client. ### Developers: +* When new features are added to the repo, a short description of the feature should be added under the "Next Release" heading. +* This should be done in the same PR as the change so that our release notes stay in sync! ### Release Manager: +* All of the items under the "Next Release" heading should be included in the release notes. +* As part of the PR that bumps the client version, cut everything below the 'Next Release' heading. +* These notes can either be pasted in a temporary doc, or you can get them from the PR diff once it is merged. +* The notes are just a guideline as to the changes that have been made since the last release, they can be updated. +* Once the version bump PR is merged and tagged, add the release notes to the tag on GitHub. ## Next release