mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 01:43:22 +01:00
Code Issues Projects Releases Wiki Activity

Clarify contribution guidelines around rebasing PRs (#2591)

Browse Source 
It isn't obvious when a contributor should rebase a PR.
Hopefully the additional paragraph clarifies the rules around rebasing.
This commit is contained in:
Bastien Teinturier 2023-01-31 13:28:12 +01:00 committed by GitHub
parent 198fd934f3
commit f23e2c5fc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -89,6 +89,12 @@ mark the comment as resolved: let the reviewer verify your commit, they will mar
resolved if they agree with the fix. This makes it easier for reviewers to check that all their
comments have been addressed.
Rebasing a pull request while it is being reviewed makes it hard for reviewers to see what changed
since their last review. Whenever possible, you should avoid rebasing and should only append new
commits to the pull request. But you will have to rebase if your pull request conflicts with the
master branch. When that happens, do not add new changes inside the rebased commits (except to fix
conflicts of course): new changes should be added by additional commits after the rebase.
It's recommended to take great care in writing tests and ensuring the entire test suite has a
stable successful outcome; eclair uses continuous integration techniques and having a stable build
helps the reviewers with their job.