diff options
| author | Angelos Evripiotis <jevripiotis@bloomberg.net> | 2018-11-07 10:16:59 +0000 |
|---|---|---|
| committer | Angelos Evripiotis <angelos.evripiotis@gmail.com> | 2018-11-08 15:49:16 +0000 |
| commit | f7231e90da32d020d8fc2e0488c1343aa0fefb61 (patch) | |
| tree | 9bffb793fe0820183817cecf71429797d4126909 /CONTRIBUTING.rst | |
| parent | c0a8bb664fe2165c6a94b95f337c6f75f9e14362 (diff) | |
| download | buildstream-f7231e90da32d020d8fc2e0488c1343aa0fefb61.tar.gz | |
contributing: non-WIP should always be landable
I was recently surprised that we don't prefer addressing review comments
in 'fixup!' commits.
Coming from GitHub, I've found that fixup commits make it easier for
reviewers to see what has changed since their last review. The idea is
to use '--autosquash' before landing to clean up the history again.
It's a pleasant surprise that it's easy to keep track of what changed in
merge-requests between pushes, so we can always keep the history clean.
Document this, so folks like me can see the light sooner.
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8d4abf979..72a0bd116 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -128,6 +128,12 @@ If a commit in your branch modifies behavior such that a test must also be changed to match the new behavior, then the tests should be updated with the same commit, so that every commit passes its own tests. +These principles apply whenever a branch is non-WIP. So for example, don't push +'fixup!' commits when addressing review comments, instead amend the commits +directly before pushing. GitLab has `good support +<https://docs.gitlab.com/ee/user/project/merge_requests/versions.html>`_ for +diffing between pushes, so 'fixup!' commits are not necessary for reviewers. + Commit messages ~~~~~~~~~~~~~~~ |