Merge #15243: [doc] add notes on release notes
65bc38d1c1
[doc] add notes on release notes (John Newbery)
Pull request description:
Explains when and how release notes should be written.
Tree-SHA512: 94085d5a30499f41e6d1821b9f157aea40b3cff61a8ba606fed1b239e794ffe6769f985f53400715d712d12aadaa8db8cfca08dd1700a1fe17df86e0e554eac2
This commit is contained in:
commit
bd8bda161e
1 changed files with 16 additions and 0 deletions
|
@ -35,6 +35,7 @@ Developer Notes
|
|||
- [Subtrees](#subtrees)
|
||||
- [Git and GitHub tips](#git-and-github-tips)
|
||||
- [Scripted diffs](#scripted-diffs)
|
||||
- [Release notes](#release-notes)
|
||||
- [RPC interface guidelines](#rpc-interface-guidelines)
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
@ -874,6 +875,21 @@ test/lint/commit-script-check.sh origin/master..HEAD
|
|||
|
||||
Commit [`bb81e173`](https://github.com/bitcoin/bitcoin/commit/bb81e173) is an example of a scripted-diff.
|
||||
|
||||
Release notes
|
||||
-------------
|
||||
|
||||
Release notes should be written for any PR that:
|
||||
|
||||
- introduces a notable new feature
|
||||
- fixes a significant bug
|
||||
- changes an API or configuration model
|
||||
- makes any other visible change to the end-user experience.
|
||||
|
||||
Release notes should be added to a PR-specific release note file at
|
||||
`/doc/release-notes-<PR number>.md` to avoid conflicts between multiple PRs.
|
||||
All `release-notes*` files are merged into a single
|
||||
[/doc/release-notes.md](/doc/release-notes.md) file prior to the release.
|
||||
|
||||
RPC interface guidelines
|
||||
--------------------------
|
||||
|
||||
|
|
Loading…
Reference in a new issue