Skip to content

Commit

Permalink
[doc] add notes on release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jnewbery committed Jan 24, 2019
1 parent 72bd4ab commit 65bc38d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions doc/developer-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down Expand Up @@ -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
--------------------------

Expand Down

0 comments on commit 65bc38d

Please sign in to comment.