Skip to content

Commit 2a6bce4

Browse files
carnhofdakilaanwjhebastopromagfanquake
committed
doc: Add a note about backporting
See laanwj's comment in #17158 bitcoin/bitcoin#17158 (comment) Co-Authored-By: Wladimir J. van der Laan <[email protected]> Co-Authored-By: Hennadii Stepanov <[email protected]> Co-Authored-By: João Barbosa <[email protected]> Co-Authored-By: Michael <[email protected]> Co-Authored-By: Luke Dashjr <[email protected]>
1 parent e8e7995 commit 2a6bce4

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,31 @@ about:
309309
when someone else is asking for feedback on their code, and universe balances out.
310310

311311

312+
Backporting
313+
-----------
314+
315+
Security and bug fixes can be backported from `master` to release
316+
branches.
317+
If the backport is non-trivial, it may be appropriate to open an
318+
additional PR, to backport the change, only after the original PR
319+
has been merged.
320+
Otherwise, backports will be done in batches and
321+
the maintainers will use the proper `Needs backport (...)` labels
322+
when needed (the original author does not need to worry).
323+
324+
A backport should contain the following metadata in the commit body:
325+
326+
```
327+
Github-Pull: #<PR number>
328+
Rebased-From: <commit hash of the original commit>
329+
```
330+
331+
Have a look at [an example backport PR](
332+
https://github.com/bitcoin/bitcoin/pull/16189).
333+
334+
Also see the [backport.py script](
335+
https://github.com/bitcoin-core/bitcoin-maintainer-tools#backport).
336+
312337
Release Policy
313338
--------------
314339

0 commit comments

Comments
 (0)