summary refs log tree commit diff
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLeonhard Markert <curiousleo@users.noreply.github.com>2020-01-10 12:59:28 +0100
committerLeonhard Markert <curiousleo@users.noreply.github.com>2020-01-13 15:33:16 +0100
commitd6a98987717b31e2d89b267608ea6c90bd5eea56 (patch)
treed8b5c00793ef7dfb0892698708056cf064d88f1c /.github/CONTRIBUTING.md
parent384d963920448ec2c9399ba2d62d491af0ddb5ba (diff)
downloadnixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.tar
nixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.tar.gz
nixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.tar.bz2
nixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.tar.lz
nixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.tar.xz
nixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.tar.zst
nixpkgs-d6a98987717b31e2d89b267608ea6c90bd5eea56.zip
CONTRIBUTING.md: add section "Backporting changes"
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 706952b208d..a50a8a507de 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -48,6 +48,15 @@ In addition to writing properly formatted commit messages, it's important to inc
 
 For package version upgrades and such a one-line commit message is usually sufficient.
 
+## Backporting changes
+
+To [backport a change into a release branch](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches):
+
+1. Take note of the commit in which the change was introduced into `master`.
+2. Check out the target _release branch_, e.g. `release-19.09`. Do not use a _channel branch_ like `nixos-19.09` or `nixpkgs-19.09`.
+3. Use `git cherry-pick -x <original commit>`.
+4. Open your backport PR. Make sure to select the release branch (e.g. `release-19.09`) as the target branch of the PR, and link to the PR in which the original change was made to `master`.
+
 ## Reviewing contributions
 
 See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).