diff options
| author | Michael Kaye <1917473+michaelkaye@users.noreply.github.com> | 2020-02-04 16:21:09 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-04 16:21:09 +0000 |
| commit | c87572d6e426099fa36e2cd8260319531ec0fbb8 (patch) | |
| tree | 42ae8cf800edde5cf7da695bfa7ea8e9c89e08a3 | |
| parent | Merge pull request #6837 from matrix-org/rav/federation_async (diff) | |
| download | synapse-c87572d6e426099fa36e2cd8260319531ec0fbb8.tar.xz | |
Update CONTRIBUTING.md about merging PRs. (#6846)
| -rw-r--r-- | CONTRIBUTING.md | 14 | ||||
| -rw-r--r-- | changelog.d/6846.doc | 1 |
2 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5736ede6c4..4b01b6ac8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -200,6 +200,20 @@ 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 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 +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 diff --git a/changelog.d/6846.doc b/changelog.d/6846.doc new file mode 100644 index 0000000000..ad69d608c0 --- /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 |