[doc] add notes on release notes #15243
Conversation
doc/developer-notes.md
Outdated
There was a problem hiding this comment.
Why do we suggest something that's going to break outside of users' control?
There was a problem hiding this comment.
Sorry, I don't understand the question.
There was a problem hiding this comment.
If you suggest this, people will do it, and things will break. Why not have them do the latter and make a new file?
There was a problem hiding this comment.
I think it's up to the individual contributor, but I'm happy to change this to just suggest using release-notes-XXXXX.md.
There was a problem hiding this comment.
I think a single actionable item is better than 2, one of which has negative externalities(maybe just me)
There was a problem hiding this comment.
IMO I'd leave both - the PR author has the right to update doc/release-notes.md, especially if he wants to work out existing text.
There's also the case where one PR XXX updates release-notes-YYY.md
to avoid conflicts between multiple PRs.
IMO the conflicts in release notes shouldn't be postponed to release time.
There was a problem hiding this comment.
@promag they're typically not real conflicts, but "oops pushed a line down" conflicts.
There was a problem hiding this comment.
I think that's fine, that also happens with code and must be fixed accordingly. I'm not against individual files, both options are valid for me.
Anyway, looks like now I'm forced to write individual release notes. See #15193 for instance, would you NACK it because it doesn't create an individual file?
There was a problem hiding this comment.
Just my opinion, everyone else seems to disagree :)
There was a problem hiding this comment.
I don't want to make this prescriptive that you can't write notes in release-notes.md, and I certainly wouldn't want to encourage "please move release notes to a separate file" review comments. However, I agree with instagibbs that only presenting one action is better.
I'm happy to go either way.
|
Thanks for adding this, ACK |
jnewbery
force-pushed
the
release_notes
branch
from
28dd307 to
65bc38d
Compare
|
For historical context, this was discussed in an IRC meeting here: http://www.erisian.com.au/meetbot/bitcoin-core-dev/2018/bitcoin-core-dev.2018-03-29-19.03.log.html#l-57 |
|
ACK |
|
ACK 65bc38d |
65bc38d [doc] add notes on release notes (John Newbery) Pull request description: Explains when and how release notes should be written. Tree-SHA512: 94085d5a30499f41e6d1821b9f157aea40b3cff61a8ba606fed1b239e794ffe6769f985f53400715d712d12aadaa8db8cfca08dd1700a1fe17df86e0e554eac2
Summary: The procedure of writing notes to diff-specific files to avoid conflicts does not seem useful for Bitcoin ABC, as we don't take as long for reviews as Core does. This is a backport of Core [[bitcoin/bitcoin#15243 | PR15243]] Test Plan: Proof-reading. Reviewers: #bitcoin_abc, majcosta Reviewed By: #bitcoin_abc, majcosta Differential Revision: https://reviews.bitcoinabc.org/D8434
65bc38d [doc] add notes on release notes (John Newbery) Pull request description: Explains when and how release notes should be written. Tree-SHA512: 94085d5a30499f41e6d1821b9f157aea40b3cff61a8ba606fed1b239e794ffe6769f985f53400715d712d12aadaa8db8cfca08dd1700a1fe17df86e0e554eac2
65bc38d [doc] add notes on release notes (John Newbery) Pull request description: Explains when and how release notes should be written. Tree-SHA512: 94085d5a30499f41e6d1821b9f157aea40b3cff61a8ba606fed1b239e794ffe6769f985f53400715d712d12aadaa8db8cfca08dd1700a1fe17df86e0e554eac2
65bc38d [doc] add notes on release notes (John Newbery) Pull request description: Explains when and how release notes should be written. Tree-SHA512: 94085d5a30499f41e6d1821b9f157aea40b3cff61a8ba606fed1b239e794ffe6769f985f53400715d712d12aadaa8db8cfca08dd1700a1fe17df86e0e554eac2
6 participants
Explains when and how release notes should be written.