admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

docs: clarify GitHub merge workflow usage

Browse Source 
Co-Authored-By: Sam Ford <1584702+samford@users.noreply.github.com>
This commit is contained in:
Rylan Polster 2020-12-30 16:22:46 -05:00
parent ac3ce218e3
commit bca13a4926
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Maintainer-Guidelines.md
View File

@ -26,7 +26,7 @@ This is all that really matters:
[pip](https://pip.pypa.io/en/stable/). [pip](https://pip.pypa.io/en/stable/).
- Ensure that any dependencies are accurate and minimal. We don't need to - Ensure that any dependencies are accurate and minimal. We don't need to
support every possible optional feature for the software. support every possible optional feature for the software.
- Use the GitHub squash & merge or rebase & merge workflows where bottles aren't required. - When bottles aren't required or affected, use the GitHub squash & merge workflow for a single-formula PR or rebase & merge workflow for a multiple-formulae PR. See [below](#how-to-merge-without-bottles) for more details.
- Use `brew pr-publish` or `brew pr-pull` otherwise, which adds messages to auto-close pull requests and pull bottles built by the Brew Test Bot. - Use `brew pr-publish` or `brew pr-pull` otherwise, which adds messages to auto-close pull requests and pull bottles built by the Brew Test Bot.
- Thank people for contributing. - Thank people for contributing.
@ -80,7 +80,9 @@ Here’s a flowchart for managing a PR which is ready to merge:
![Flowchart for managing pull requests](assets/img/docs/managing-pull-requests.drawio.svg) ![Flowchart for managing pull requests](assets/img/docs/managing-pull-requests.drawio.svg)
Here are guidelines about when to use squash & merge versus rebase & merge. These options should only be used when bottles are not needed. #### How to merge without bottles
Here are guidelines about when to use squash & merge versus rebase & merge. These options should only be used with PRs where bottles are not needed or affected.
| | PR modified a single formula | PR modifies multiple formulae | | | PR modified a single formula | PR modifies multiple formulae |
|---|---|---| |---|---|---|