diff options
author | davidak <davidak@users.noreply.github.com> | 2020-04-22 00:50:51 +0200 |
---|---|---|
committer | davidak <git@davidak.de> | 2020-04-26 19:35:13 +0200 |
commit | 9c32e5c495b76f9dee4ce2d5752bd65c9fad9835 (patch) | |
tree | 19c65605fe3259ef8979f81c1bd454552c8679bb /.github/CONTRIBUTING.md | |
parent | e71990711f699b0f31173a6eec3a1941af938e2d (diff) |
CONTRIBUTING.md: Improve backport instructions
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r-- | .github/CONTRIBUTING.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ae4f68dddc19c..cb0264b0167f5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -50,12 +50,13 @@ For package version upgrades and such a one-line commit message is usually suffi ## Backporting changes -To [backport a change into a release branch](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches): +Follow these steps to backport a change into a release branch in compliance with the [commit policy](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches). -1. Take note of the commit in which the change was introduced into `master`. +1. Take note of the commits in which the change was introduced into `master` branch. 2. Check out the target _release branch_, e.g. `release-20.03`. Do not use a _channel branch_ like `nixos-20.03` or `nixpkgs-20.03`. -3. Use `git cherry-pick -x <original commit>`. -4. Open your backport PR. Make sure to select the release branch (e.g. `release-20.03`) as the target branch of the PR, and link to the PR in which the original change was made to `master`. +3. Create a branch for your change, e.g. `git checkout -b backport`. +4. When the reason to backport is not obvious from the original commit message, use `git cherry-pick -xe <original commit>` and add a reason. Otherwise use `git cherry-pick -x <original commit>`. That's fine for minor version updates that only include security and bug fixes, commits that fixes an otherwise broken package or similar. +5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-20.03`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[20.03]`. ## Reviewing contributions |