Skip to content

Commit 65bc38d

Browse files
committed
[doc] add notes on release notes
1 parent 72bd4ab commit 65bc38d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/developer-notes.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Developer Notes
3535
- [Subtrees](#subtrees)
3636
- [Git and GitHub tips](#git-and-github-tips)
3737
- [Scripted diffs](#scripted-diffs)
38+
- [Release notes](#release-notes)
3839
- [RPC interface guidelines](#rpc-interface-guidelines)
3940

4041
<!-- markdown-toc end -->
@@ -874,6 +875,21 @@ test/lint/commit-script-check.sh origin/master..HEAD
874875

875876
Commit [`bb81e173`](https://github.com/bitcoin/bitcoin/commit/bb81e173) is an example of a scripted-diff.
876877

878+
Release notes
879+
-------------
880+
881+
Release notes should be written for any PR that:
882+
883+
- introduces a notable new feature
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 a PR-specific release note file at
889+
`/doc/release-notes-<PR number>.md` to avoid conflicts between multiple PRs.
890+
All `release-notes*` files are merged into a single
891+
[/doc/release-notes.md](/doc/release-notes.md) file prior to the release.
892+
877893
RPC interface guidelines
878894
--------------------------
879895

0 commit comments

Comments
 (0)