[doc] add notes on release notes #15243

pull jnewbery wants to merge 1 commits into bitcoin:master from jnewbery:release_notes changing 1 files +16 −0

jnewbery commented at 2:57 PM on January 24, 2019: member

Explains when and how release notes should be written.
fanquake added the label Docs on Jan 24, 2019
in doc/developer-notes.md:889 in 28dd307595 outdated
```
 884 | +- fixes a significant bug
 885 | +- changes an API or configuration model
 886 | +- makes any other visible change to the end-user experience.
 887 | +
 888 | +Release notes should be added to the release notes file in
 889 | +[/doc/release-notes.md](/doc/release-notes.md) or, to avoid conflicts between
```
instagibbs commented at 3:08 PM on January 24, 2019:

Why do we suggest something that's going to break outside of users' control?

jnewbery commented at 3:47 PM on January 24, 2019:

Sorry, I don't understand the question.

instagibbs commented at 3:50 PM on January 24, 2019:

If you suggest this, people will do it, and things will break. Why not have them do the latter and make a new file?

jnewbery commented at 4:13 PM on January 24, 2019:

I think it's up to the individual contributor, but I'm happy to change this to just suggest using release-notes-XXXXX.md.

instagibbs commented at 4:32 PM on January 24, 2019:

I think a single actionable item is better than 2, one of which has negative externalities(maybe just me)

promag commented at 5:40 PM on January 24, 2019:

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.

instagibbs commented at 5:49 PM on January 24, 2019:

@promag they're typically not real conflicts, but "oops pushed a line down" conflicts.

promag commented at 5:58 PM on January 24, 2019:

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?

instagibbs commented at 6:00 PM on January 24, 2019:

Just my opinion, everyone else seems to disagree :)

jnewbery commented at 8:32 PM on January 24, 2019:

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.
laanwj commented at 4:08 PM on January 24, 2019: member

Thanks for adding this, ACK
[doc] add notes on release notes 65bc38d1c1
jnewbery force-pushed on Jan 24, 2019
jnewbery commented at 4:16 PM on January 24, 2019: member

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
MarcoFalke commented at 10:15 PM on January 24, 2019: member

ACK
fanquake commented at 5:35 AM on January 25, 2019: member

ACK 65bc38d
laanwj merged this on Jan 30, 2019
laanwj closed this on Jan 30, 2019
laanwj referenced this in commit bd8bda161e on Jan 30, 2019
jnewbery deleted the branch on Jan 30, 2019
deadalnix referenced this in commit f41d7d4832 on Nov 18, 2020
PastaPastaPasta referenced this in commit 1f180d972b on Jun 27, 2021
PastaPastaPasta referenced this in commit d15b1c60c6 on Jun 28, 2021
PastaPastaPasta referenced this in commit 57572f45d4 on Jun 28, 2021
PastaPastaPasta referenced this in commit 90fc614500 on Jun 29, 2021
Munkybooty referenced this in commit 97d48b41d2 on Aug 21, 2021
Munkybooty referenced this in commit a207d6bfbb on Aug 23, 2021
Munkybooty referenced this in commit da7e66854a on Aug 24, 2021
Munkybooty referenced this in commit c83889afa6 on Aug 24, 2021
Munkybooty referenced this in commit 9a7f9559e5 on Aug 24, 2021
UdjinM6 referenced this in commit eb60ec3a16 on Aug 24, 2021
Munkybooty referenced this in commit 86de06e86a on Aug 24, 2021
DrahtBot locked this on Dec 16, 2021

Contributors

Labels