mutli: add release notes file to track in-repo #293
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
Requesting review from everybody, since the process affects us all. Feel free to remove yourself! |
guggero
approved these changes
Sep 10, 2020
Contributor
guggero
left a comment
guggero
left a comment
There was a problem hiding this comment.
I like the proposed process! We should definitely try this and possibly also adopt in our other projects 💯
release_notes.md
Outdated
| 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. |
Contributor
There was a problem hiding this comment.
nit: put "Next Release" in quotes?
bhandras
approved these changes
Sep 10, 2020
release_notes.md
Outdated
| # Loop Client Release Notes | ||
| This file tracks release notes for the loop client. | ||
|
|
||
| Developers: |
Member
There was a problem hiding this comment.
Consider making Developers and Release Manager bold to stand out better.
carlaKC
force-pushed
the
inrepo-releasenotes
branch
from
e7ef5ed to
e4a5bd8
Compare
Contributor
|
You could also add a PR template to the repo to remind us about adding the release notes. |
carlaKC
force-pushed
the
inrepo-releasenotes
branch
from
e4a5bd8 to
a9f8682
Compare
Contributor
Author
|
Added a PR template (just with a reminder about notes, I don't think we need the full list that lnd has) and headings to the release notes (New Features/ Breaking Changes/ Bugfixes). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a file to track release notes in-repo.
Open to suggestions to how we do this, but I think an append-only log will work?
For our next client release we will have a list like this:
On release, we just shift the heading up:
And just keep doing that. Decided on "Next Release" because we don't always know whether a change will go into a point release or a major one.