Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Update CONTRIBUTING.md about merging PRs. (#6846)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelkaye authored Feb 4, 2020
1 parent c7d6d5c commit c87572d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions changelog.d/6846.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add details of PR merge strategy to contributing docs.

0 comments on commit c87572d

Please sign in to comment.