diff options
| author | laanwj <126646+laanwj@users.noreply.github.com> | 2022-06-01 08:38:44 +0200 |
|---|---|---|
| committer | laanwj <126646+laanwj@users.noreply.github.com> | 2022-06-01 08:39:08 +0200 |
| commit | e157b98640c7cfb94cae7e0faca3bcffc2dde990 (patch) | |
| tree | 4201db6f2e271ca5a3c20b8b7c33d1497551db15 | |
| parent | beb18d3fbc0d7a21f6d8b566d9a8caf70b226a63 (diff) | |
| parent | fa2d226ac950d8b4f7e430732f13ad408c504745 (diff) | |
Merge bitcoin/bitcoin#25165: doc: Explain squashing with merge commits
fa2d226ac950d8b4f7e430732f13ad408c504745 doc: Explain squashing with merge commits (MacroFake)
Pull request description:
This avoids having to explain it in each thread
ACKs for top commit:
laanwj:
ACK fa2d226ac950d8b4f7e430732f13ad408c504745
Tree-SHA512: e1533ee7c0ab0101c78aaebed97dc889b5eb941cf4c2dfbabbb5f0ec1bb7b1313a1a2e2405235d68c761f039373cebac67ce691a72c820a9252429d50c1ac7d5
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aec6995d3b..0ae4ff1a92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -216,9 +216,9 @@ Please update the resulting commit message, if needed. It should read as a coherent message. In most cases, this means not just listing the interim commits. -If you have problems with squashing or other git workflows, you can enable -"Allow edits from maintainers" in the right-hand sidebar of the GitHub web -interface and ask for help in the pull request. +If your change contains a merge commit, the above workflow may not work and you +will need to remove the merge commit first. See the next section for details on +how to rebase. Please refrain from creating several pull requests for the same change. Use the pull request that is already open (or was created earlier) to amend @@ -231,7 +231,9 @@ pull request to pull request. ### Rebasing Changes When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch. -The `git rebase` command will take care of rebuilding your commits on top of the new base. + + git fetch https://github.com/bitcoin/bitcoin # Fetch the latest upstream commit + git rebase FETCH_HEAD # Rebuild commits on top of the new base This project aims to have a clean git history, where code changes are only made in non-merge commits. This simplifies auditability because merge commits can be assumed to not contain arbitrary code changes. Merge commits should be signed, |