Skip to content
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

Merged
merged 3 commits into from
Sep 20, 2021
Merged

Add release notes in the repository #1951

merged 3 commits into from
Sep 20, 2021

Conversation

t-bast
Copy link
Member

@t-bast t-bast commented Sep 14, 2021

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).

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.
docs/release-notes/eclair-vnext.md Show resolved Hide resolved
docs/release-notes/eclair-vnext.md Show resolved Hide resolved
docs/release-notes/eclair-vnext.md Outdated Show resolved Hide resolved
thomash-acinq
thomash-acinq previously approved these changes Sep 20, 2021
Copy link
Member

@pm47 pm47 left a 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?

@t-bast
Copy link
Member Author

t-bast commented Sep 20, 2021

Should we add guidance on when/how to edit this file in the CONTRIBUTING.md?

Good idea, done in 75ae8dd

@codecov-commenter
Copy link

Codecov Report

Merging #1951 (75ae8dd) into master (fb0199c) will increase coverage by 0.05%.
The diff coverage is n/a.

@@            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     
Impacted Files Coverage Δ
...ir-core/src/main/scala/fr/acinq/eclair/Setup.scala 80.45% <0.00%> (-0.12%) ⬇️
...-core/src/main/scala/fr/acinq/eclair/io/Peer.scala 90.04% <0.00%> (ø)
...c/main/scala/fr/acinq/eclair/channel/Channel.scala 88.27% <0.00%> (ø)
...c/main/scala/fr/acinq/eclair/channel/Helpers.scala 96.16% <0.00%> (ø)
...lockchain/bitcoind/rpc/ExtendedBitcoinClient.scala
...eclair/blockchain/bitcoind/BitcoinCoreWallet.scala
...ir/blockchain/bitcoind/rpc/BitcoinCoreClient.scala 94.23% <0.00%> (ø)
...clair/channel/publish/ReplaceableTxPublisher.scala 87.05% <0.00%> (+1.17%) ⬆️
...main/scala/fr/acinq/eclair/router/Validation.scala 92.30% <0.00%> (+1.53%) ⬆️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants