-
Notifications
You must be signed in to change notification settings - Fork 267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add release notes in the repository #1951
Conversation
It's useful to have the release notes directly inside the repository instead of relying on Github: that lets for example users read them offline. It also lets us fill the release notes every time we add relevant features on `master` instead of having to do them all at once when we decide to make a release.
a7e7f9e
to
7f0f500
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add guidance on when/how to edit this file in the CONTRIBUTING.md
?
Good idea, done in 75ae8dd |
Codecov Report
@@ Coverage Diff @@
## master #1951 +/- ##
==========================================
+ Coverage 87.63% 87.69% +0.05%
==========================================
Files 159 158 -1
Lines 12441 12389 -52
Branches 526 533 +7
==========================================
- Hits 10903 10864 -39
+ Misses 1538 1525 -13
|
It's useful to have the release notes directly inside the repository instead of relying on Github: that lets for example users read them offline.
It also lets us fill the release notes every time we add relevant features on
master
instead of having to do them all at once when we decide to make a release. Every time a contributor makes a PR that should be included in the release notes, we should ask the contributor to update the release notes directly inside the PR. That ensures release notes are thorough and accurate, and splits the work between all contributors.I copy-pasted the release notes of the last release (0.6.1) and create the draft release notes for the next release, so that we can start this process ASAP. I already filled the next release notes with everything noteworthy that happened since v0.6.1. @thomash-acinq can you please double-check what I put for A/B testing? And let me know if you want to add something about the changes you made to the heuristics (in particular the virtual hop cost).