From da6bcce297a1f036c7b8bdcb77ba903b72a6a41c Mon Sep 17 00:00:00 2001 From: carla Date: Thu, 10 Sep 2020 14:05:36 +0200 Subject: [PATCH 1/2] mutli: add release notes file to track in-repo --- release_notes.md | 18 ++++++++++++++++++ version.go | 1 + 2 files changed, 19 insertions(+) create mode 100644 release_notes.md diff --git a/release_notes.md b/release_notes.md new file mode 100644 index 0000000..8874258 --- /dev/null +++ b/release_notes.md @@ -0,0 +1,18 @@ +# 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, the "Next Release" heading should be replaced with the release version including the changes. + +## Next Release + +#### New Features + +#### Breaking Changes + +#### Bug Fixes \ No newline at end of file diff --git a/version.go b/version.go index 67dc9f2..108b5b0 100644 --- a/version.go +++ b/version.go @@ -21,6 +21,7 @@ const semanticAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqr // These constants define the application version and follow the semantic // versioning 2.0.0 spec (http://semver.org/). const ( + // Note: please update release_notes.md when you change these values. appMajor uint = 0 appMinor uint = 8 appPatch uint = 1 From a9f8682689f4259a9765f3974b563b2a51bdcb55 Mon Sep 17 00:00:00 2001 From: carla Date: Fri, 11 Sep 2020 08:59:01 +0200 Subject: [PATCH 2/2] github: add pull request reminder to update release notes --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..66ed713 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,2 @@ +#### Pull Request Checklist +- [ ] Update `release_notes.md` if your PR contains major features, breaking changes or bugfixes