From 551d77c04d7c719b6b6faea4fb17fc951210072e Mon Sep 17 00:00:00 2001 From: Michael Kaye <1917473+michaelkaye@users.noreply.github.com> Date: Tue, 4 Feb 2020 11:06:52 +0000 Subject: [PATCH 1/4] Some words about merge practice --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5736ede6c40c..edf6a8474c63 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -200,6 +200,19 @@ Git allows you to add this signoff automatically when using the `-s` flag to `git commit`, which uses the name and email set in your `user.name` and `user.email` git configs. +## Merge Strategy + +We use the commit history of develop/master extensively to identify +when regressions were introduced and what changes have been made. + +We aim to have a clean merge history, which means we normally squash-merge +changes into develop. For small changes this means there is no need to rebase +to clean up your PR before merging. Larger changes with an organised set of +commits may be merged as-is, if the history is judged useful. + +This use of squash-merging will mean PRs built on each other will be hard to +merge. We suggest avoiding these where possible, and if required, ensuring each PR has a tidy set of commits to ease merging. + ## Conclusion That's it! Matrix is a very open and collaborative project as you might expect From 835c1bf772ee79e0a58800bd21b368c63b3428c2 Mon Sep 17 00:00:00 2001 From: Michael Kaye <1917473+michaelkaye@users.noreply.github.com> Date: Tue, 4 Feb 2020 11:07:55 +0000 Subject: [PATCH 2/4] Line formatting --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edf6a8474c63..57fdc1b371c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -211,7 +211,8 @@ to clean up your PR before merging. Larger changes with an organised set of commits may be merged as-is, if the history is judged useful. This use of squash-merging will mean PRs built on each other will be hard to -merge. We suggest avoiding these where possible, and if required, ensuring each PR has a tidy set of commits to ease merging. +merge. We suggest avoiding these where possible, and if required, ensuring +each PR has a tidy set of commits to ease merging. ## Conclusion From 063a53d45874f7a48a978d52f26754f68874290a Mon Sep 17 00:00:00 2001 From: Michael Kaye <1917473+michaelkaye@users.noreply.github.com> Date: Tue, 4 Feb 2020 14:16:19 +0000 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57fdc1b371c3..4b01b6ac8ca2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -208,7 +208,7 @@ when regressions were introduced and what changes have been made. We aim to have a clean merge history, which means we normally squash-merge changes into develop. For small changes this means there is no need to rebase to clean up your PR before merging. Larger changes with an organised set of -commits may be merged as-is, if the history is judged useful. +commits may be merged as-is, if the history is judged to be useful. This use of squash-merging will mean PRs built on each other will be hard to merge. We suggest avoiding these where possible, and if required, ensuring From 285f8ec71c10635c0d48610d6b18c30c4af6901f Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 4 Feb 2020 15:23:52 +0000 Subject: [PATCH 4/4] Add changelog --- changelog.d/6846.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/6846.doc diff --git a/changelog.d/6846.doc b/changelog.d/6846.doc new file mode 100644 index 000000000000..ad69d608c08e --- /dev/null +++ b/changelog.d/6846.doc @@ -0,0 +1 @@ +Add details of PR merge strategy to contributing docs. \ No newline at end of file