summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@ifm.com>2022-02-11 08:49:54 +0100
committerMatthias Beyer <matthias.beyer@ifm.com>2022-03-07 07:41:55 +0100
commit09bea055bb3f61e239e0b3f6ef6173467dd66a37 (patch)
tree728004cd4e69ae8d0bd272273c3c536abac6e727 /CONTRIBUTING.md
parenteebff4d8799010a154c1dc31ae4a3eda27b8a6cd (diff)
Add note about fixup commits
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 53426f81..a565dc9b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,6 +36,10 @@ Git commit messages should explain the how and why of your change and be separat
Generally, pull requests need at least an approval from one maintainer to be merged.
When addressing review feedback, it is helpful to the reviewer if additional changes are made in new commits. This allows the reviewer to easily see the delta between what they previously reviewed and the changes you added to address their feedback.
+If applicable, the `git commit --fixup=<sha>` feature should be used.
+These fixup commits should then be squashed
+(usually `git rebase -i --autosquash main`) by the author of the PR after it
+passed review and before it is merged.
Once a PR has the necessary approvals, it can be merged. Here’s how the merge should be handled: