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

Update CONTRIBUTING.md about merging PRs. #6846

Merged
merged 5 commits into from
Feb 4, 2020

Conversation

michaelkaye
Copy link
Contributor

Update contributing to add new suggested section on Merge Strategy based on chat on synapse-dev.

(I don't care about the details of this, I think I've captured the idea, but feel free to bikeshed as required. All I'm looking for is the intent written down so I don't forget to ask each time).

@michaelkaye michaelkaye requested a review from a team February 4, 2020 11:10
Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just needs a changelog, which is a 6846.doc file placed in changelog.d.

Something like "Add details of PR merge strategy to contributing docs."

@anoadragon453 anoadragon453 self-assigned this Feb 4, 2020
Copy link
Contributor

@neilisfragile neilisfragile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm with a minor nit.

CONTRIBUTING.md Outdated
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'judged to be useful'?

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@anoadragon453 anoadragon453 changed the base branch from master to develop February 4, 2020 16:20
@anoadragon453 anoadragon453 merged commit c87572d into develop Feb 4, 2020
@anoadragon453 anoadragon453 deleted the michaelkaye/note_merge_strategy branch February 4, 2020 16:21
babolivier pushed a commit that referenced this pull request Sep 1, 2021
* commit 'c87572d6e':
  Update CONTRIBUTING.md about merging PRs. (#6846)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants