aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn Newbery <john@johnnewbery.com>2019-01-24 09:54:53 -0500
committerJohn Newbery <john@johnnewbery.com>2019-01-24 11:14:43 -0500
commit65bc38d1c1f666e2c2d773111921b115d4249563 (patch)
tree7ab53458c0f8fa8ce91f0d95f1cd08d58d625383 /doc
parent72bd4ab867e3be0d8410403d9641c08288d343e3 (diff)
[doc] add notes on release notes
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index e0def4ea27..ec29310ffe 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -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
--------------------------