Skip to content

Add flowchart for managing ready-to-merge PRs #8627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2020
Merged

Add flowchart for managing ready-to-merge PRs #8627

merged 2 commits into from
Sep 8, 2020

Conversation

claui
Copy link
Contributor

@claui claui commented Sep 5, 2020

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew tests with your changes locally?

This documentation PR adds a flowchart and a diagram guideline.

Flowchart for managing ready-to-merge PRs

A flowchart can be a helpful addition to a complex decision tree.
Many thanks to @SMillerDev for the idea and initial version of the chart.

Flowchart for managing pull requests

New diagram guideline

Looks like this is the first diagram in the Homebrew documentation so it’s a good time for a little guideline, too.
Pinging @Homebrew/tsc but feedback welcome from everyone, of course.

Sorry, something went wrong.

@claui claui added the documentation Documentation changes label Sep 5, 2020
@SMillerDev
Copy link
Member

I'd say the stuff about the driver should be a separate pull request. It's useful, but it really distracts from the added diagram.

@claui
Copy link
Contributor Author

claui commented Sep 6, 2020

I'd say the stuff about the driver should be a separate pull request.

Makes sense! Removed for now.

@nandahkrishna
Copy link
Member

nandahkrishna commented Sep 6, 2020

I don't mean to be bikeshedding here, but the "Modify and push" text doesn't have a white background (like "Push the button" and unlike "Yes"), so the "a" in "and" seems a little too close to the line. Is it possible to make the text background white or is it intentionally this way? Disclaimer: I don't know anything about rules for diagrams 😅

- Add flowchart for handling ready-to-merge pull requests

- Add diagram guidelines

Many thanks to Sean Molenaar for the idea and initial version of the
chart.

CC: Sean Molenaar <smillernl@me.com>
@claui
Copy link
Contributor Author

claui commented Sep 6, 2020

I don't mean to be bikeshedding here, but the "Modify and push" text doesn't have a white background

@nandahkrishna Fixed, thanks!

And yes, that’s exactly the kind of feedback I meant to solicit ❤️

@claui claui requested review from Rylan12 and MikeMcQuaid September 7, 2020 21:53
Copy link
Member

@Rylan12 Rylan12 left a comment

Choose a reason for hiding this comment

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

The diagram looks good to me. If you wanted to reduce the complexity a little bit, you could probably combine the "Does it say bottle :unneeded?" and "Rebuild bottles afterwards?" questions into e.g. "Are there bottles that need to be rebuilt?". The benefit here would be to simplify the diagram a little, but I don't think that's necessary.

@reitermarkus
Copy link
Member

Are there bottles that need to be rebuilt?

I don't think it's really clear how to answer this question without the explicit “check for bottle :unneeded” step.

Copy link
Member

@MikeMcQuaid MikeMcQuaid 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, thanks for this @claui and all the help @SMillerDev and others.

@claui claui merged commit 08ab2d7 into Homebrew:master Sep 8, 2020
@claui claui deleted the pr-diagram branch September 8, 2020 14:22
@claui
Copy link
Contributor Author

claui commented Sep 8, 2020

Thank you all for the thorough review and helpful feedback @nandahkrishna @Rylan12 @SMillerDev @MikeMcQuaid @reitermarkus!

@Rylan12
Copy link
Member

Rylan12 commented Sep 8, 2020

Looks good! One minor thing: the color of the ✅ is a little distorted. It's not unreadable, though, so maybe not worth fixing.

Screen Shot 2020-09-08 at 11 41 19 AM

@MikeMcQuaid
Copy link
Member

Thanks @claui! Would be good to fix that if possible.

@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Dec 13, 2020
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Dec 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation changes outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants