summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSandro <sandro.jaeckel@gmail.com>2022-12-14 23:36:21 +0100
committerGitHub <noreply@github.com>2022-12-14 23:36:21 +0100
commit756a5e6b74f786f08fa3a4c006b31fa316133566 (patch)
tree235c3072a94f40a21b4687b6ef9296bf6dc3200f /CONTRIBUTING.md
parentb5f35b1c859db8dd86c1b7b90f1d9c533528dfc3 (diff)
downloadnixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.tar
nixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.tar.gz
nixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.tar.bz2
nixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.tar.lz
nixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.tar.xz
nixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.tar.zst
nixpkgs-756a5e6b74f786f08fa3a4c006b31fa316133566.zip
CONTRIBUTING: loose squash merging rules (#204988)
Co-authored-by: Naïm Favier <n@monade.li>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 94ed7f02f01..46fe47e0590 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -53,9 +53,9 @@ In addition to writing properly formatted commit messages, it's important to inc
 
 Package version upgrades usually allow for simpler commit messages, including attribute name, old and new version, as well as a reference to the relevant release notes/changelog. Every once in a while a package upgrade requires more extensive changes, and that subsequently warrants a more verbose message.
 
-We prefer not to use the "squash merge" feature in nixpkgs: in order to keep as much information as possible in the commit history, we expect pull requests to consist of self-contained commits as described above.
-This means that, after addressing review comments and before the PR is merged, you will sometimes need to rewrite your branch's history and then force-push it with `git push --force-with-lease`.
-Useful commands to be comfortable with are `git commit --amend`, `git commit --fixup` and `git rebase -i` (and don't forget that git lets you define aliases!).
+Pull requests should not be squash merged in order to keep complete commit messages and GPG signatures intact and must not be when the change doesn't make sense as a single commit.
+This means that, when addressing review comments in order to keep the pull request in an always mergeable status, you will sometimes need to rewrite your branch's history and then force-push it with `git push --force-with-lease`.
+Useful git commands that can help a lot with this are `git commit --patch --amend` and `git rebase --interactive @~3`. For more details consult the git man pages.
 
 ## Rebasing between branches (i.e. from master to staging)