File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change @@ -35,6 +35,7 @@ Developer Notes
35
35
- [ Subtrees] ( #subtrees )
36
36
- [ Git and GitHub tips] ( #git-and-github-tips )
37
37
- [ Scripted diffs] ( #scripted-diffs )
38
+ - [ Release notes] ( #release-notes )
38
39
- [ RPC interface guidelines] ( #rpc-interface-guidelines )
39
40
40
41
<!-- markdown-toc end -->
@@ -874,6 +875,21 @@ test/lint/commit-script-check.sh origin/master..HEAD
874
875
875
876
Commit [ ` bb81e173 ` ] ( https://github.com/bitcoin/bitcoin/commit/bb81e173 ) is an example of a scripted-diff.
876
877
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
+
877
893
RPC interface guidelines
878
894
--------------------------
879
895
You can’t perform that action at this time.
0 commit comments