Skip to content

Commit f23e2c5

Browse files
authored
Clarify contribution guidelines around rebasing PRs (#2591)
It isn't obvious when a contributor should rebase a PR. Hopefully the additional paragraph clarifies the rules around rebasing.
1 parent 198fd93 commit f23e2c5

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ mark the comment as resolved: let the reviewer verify your commit, they will mar
8989
resolved if they agree with the fix. This makes it easier for reviewers to check that all their
9090
comments have been addressed.
9191

92+
Rebasing a pull request while it is being reviewed makes it hard for reviewers to see what changed
93+
since their last review. Whenever possible, you should avoid rebasing and should only append new
94+
commits to the pull request. But you will have to rebase if your pull request conflicts with the
95+
master branch. When that happens, do not add new changes inside the rebased commits (except to fix
96+
conflicts of course): new changes should be added by additional commits after the rebase.
97+
9298
It's recommended to take great care in writing tests and ensuring the entire test suite has a
9399
stable successful outcome; eclair uses continuous integration techniques and having a stable build
94100
helps the reviewers with their job.

0 commit comments

Comments
 (0)